使用说明
您的库名称
概述
🚧 你的自由意志清晰明了
Python版本支持
🚧 此库所需的Python版本
[！[支持的版本](https://img.shields.io/pypi/pyversions/.svg？徽标=python&徽标颜色=FBE072）](https://pypi.org/project/)
快速开始
🚧 快速入门的细节为用户提供了简单的演示
文档
🚧 文件的详细信息。..
可重用的GitHub操作工作流和操作
此模板提供了一套全面的 可重用的GitHub操作工作流和操作 它可以从其他存储库调用，以标准化CI/CD操作。使用此模板的项目可以利用这些集中式组件实现一致的自动化。
🚀 主要特点
- 集中管理：所有工作流和操作都保存在此模板存储库中
- 标准化操作：所有项目中一致的CI/CD流程
- 轻松集成：使用外部存储库引用的简单调用
- 全面覆盖：测试、构建、发布、Docker操作、文档和设置实用程序
📋 可用工作流
| 工作流程 | 目的 | 主要功能 |
|---|---|---|
rw_build_and_test.yaml |
运行全面的测试套件 | 单元、集成、e2e、合同测试 |
rw_run_all_test_and_record.yaml |
完整的CI报告 | CodeCov上传，SonarCloud分析 |
rw_python_package.yaml |
Python包操作 | 构建、测试、发布到PyPI |
rw_docker_operations.yaml |
Docker操作 | 构建、测试、推送、安全扫描 |
rw_parse_release_intent.yaml |
发布配置解析器 | 确定发布组件 |
rw_build_git-tag_and_create_github-release_v2.yaml |
Git标记和发布 | 自动化版本管理 |
rw_docs_operations.yaml |
文档操作 | 构建、版本、部署文档 |
📦 可用操作
| 行动 | 目的 | 主要特征 |
|---|---|---|
setup-python-uv |
Python与UV的依赖设置 | 支持多版本、智能缓存、灵活的依赖组 |
🔧 快速开始
要在项目中使用这些可重用的工作流，只需使用外部存储库引用调用它们：
# .github/workflows/ci.yaml in your project
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
test:
uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_run_all_test_and_record.yaml@master
secrets:
codecov_token: ${{ secrets.CODECOV_TOKEN }}
sonar_token: ${{ secrets.SONAR_TOKEN }}
📚 完整文档
💡 使用此模板的项目的好处
- 减少沸腾板：无需从头开始编写复杂的CI/CD工作流
- 最佳实践工作流程遵循既定的模式和安全实践
- 自动更新：Bug修复和改进集中维护
- 一致性：使用模板的所有项目的工作流行为相同
- 易于维护：在一个地方更新工作流，使所有项目受益
编码风格和遵循规则
遵循编码风格 黑色 和 皮林特 以控制代码质量。
下载状态
🚧 您的库的下载状态
[！[下载](https://pepy.tech/badge/)](https://pepy.tech/project/) [！[下载](https://pepy.tech/badge//月）](https://pepy.tech/project/)
