antsibull-fileutils -- 社区Ansible工具的文件实用程序库

此库提供了社区Ansible工具所需的文件实用程序。

您可以在antsibull-fileutils 变更日志中找到更改列表。

除非代码中另有说明，否则它根据GNU通用公共许可证v3的条款或您的选择进行许可。

antsibull-fileutils受Ansible行为准则的约束。

版本和兼容性

从1.0.0版本开始，antsibull-fileutils遵循语义版本控制，并在主要发布周期内旨在不提供破坏向后兼容性的更改。如果遇到严重的漏洞安全修复，我们可能会对此作出例外。

当前的开发版本是1.x.y。1.x.y是在main分支上开发的。

开发

安装并运行nox以运行所有测试。这就是简单贡献的全部内容！nox将在检出的项目中的.nox目录下创建虚拟环境，并安装运行测试所需的要求。

要运行特定测试

1. nox -e test仅运行单元测试；
2. nox -e coverage在运行nox -e test后显示组合覆盖率结果；
3. nox -e lint一次性运行所有代码检查器和格式化器；
4. nox -e formatters运行isort和black；
5. nox -e codeqa运行flake8、pylint、reuse lint和antsibull-changelog lint；
6. nox -e typing运行mypy和pyre

创建新版本

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

许可证

除非代码中有其他说明，否则它是在GNU通用公共许可证v3的条款下许可的，或者根据您的选择，是后续版本。有关许可证副本，请参阅LICENSES/GPL-3.0-or-later.txt。

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