请求合并时自动释放包
autopub的Python项目详细描述
自动发布
autopub使项目维护人员能够通过合并pull请求向pypi发布新的包版本。
环境
autopub用于连续集成(ci)系统,如CircleCI或Travis CI。与autopub一起使用的项目可以通过Poetry或setuptools发布。欢迎为其他CI和构建系统添加支持的贡献。
配置
可以通过目标项目的pyproject.toml
文件中的[tool.autopub]
表配置autopub设置。必需的设置包括git用户名和电子邮件地址:
[tool.autopub]git-username="Your Name"git-email="your_email@example.com"
发布文件
贡献者应该在其pull请求中包含一个RELEASE.md
文件,其中包含两位信息:
- 释放类型:主要、次要或修补程序
- 更改的说明,用作更改日志条目
示例:
Release type: patch
Add function to update version strings in multiple files.
用法
以下autopub
子命令可以用作ci流中的步骤:
- < L> {< CD5> }:检查是否存在释放文件。
autopub prepare
:更新版本字符串并向changelog添加条目。autopub build
:构建项目。autopub commit
:添加、提交和推送增量版本和更改日志更改。autopub githubrelease
:在github上创建一个新版本。autopub publish
:发布新版本。
对于仅允许一个部署步骤的系统(如travis ci),有一个命令按顺序运行上述步骤:
autopub deploy
:在一次调用中运行prepare
、build
、commit
、githubrelease
和publish
。