antsibull-docutils -- Antsibull docutils 辅助工具

一个用于Antsibull工具的Python库，其中包含一些docutils辅助工具。

antsibull-docutils 遵循Ansible 行为准则。

开发

安装并运行nox以运行所有测试。简单的贡献到此结束！nox将在检出的项目中的.nox目录内创建虚拟环境，并安装运行测试所需的要求。

运行特定测试

1. nox -e test仅运行单元测试；
2. nox -e coverage在运行nox -e test integration后显示合并的覆盖率结果；
3. nox -e lint一次性运行所有linters和formatters；
4. nox -e formatters运行isort和black；
5. nox -e codeqa运行flake8、pylint、reuse lint和antsibull-changelog lint；
6. nox -e typing运行mypy。

创建新版本

1. 运行nox -e bump -- <version> <release_summary_message>。这
   • 将更新src/antsibull_docutils/__init__.py中的包版本。
   • 创建包含release_summary部分的changelogs/fragments/<version>.yml。
   • 运行antsibull-changelog release并将更改的文件添加到git。
   • 使用消息发布 <version>提交，并运行git tag -a -m 'antsibull-docutils <version>' <version>。
   • 运行hatch build --clean。
2. 运行git push到适当的远程仓库。
3. 一旦GitHub上的CI通过，运行nox -e publish。这
   • 运行hatch publish；
   • 将版本提升到<version>.post0；
   • 将更改的文件添加到git，并运行git commit -m '发布后版本提升.'；
4. 运行git push --follow-tags到适当的远程仓库并创建GitHub发布。

许可证

除非代码中另有说明，否则它根据GNU通用公共许可证v3或，根据您的选择，更新版本的条款进行许可。有关许可证副本，请参阅LICENSES/GPL-3.0-or-later.txt。

该仓库遵循REUSE 规范来声明版权和许可信息。唯一的例外是changelog/fragments/中的更改日志片段。