antsibull-core -- Ansible 构建脚本库

构建与 Ansible 相关各种工具所需的库。

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

除非代码中另有说明，否则它根据 GNU 通用公共许可证第 3 版或您选择的较新版本授权。

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

版本和兼容性

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

当前的开发版本是 3.x.y。3.x.y 在 main 分支上开发。当前支持的主要版本是 2.x.y。2.x.y 的开发在 stable-2 分支上进行。1.x.y 已达到生命周期结束，并已在 stable-1 分支上开发。它不再更新。2.x.y 与 1.x.y 的主要区别在于不支持 Python 3.6、3.7 和 3.8。它弃用了几个不再需要的旧 Python 版本的兼容性函数；有关详细信息，请参阅变更日志。

开发

安装并运行 nox 来运行所有测试。简单的贡献就到这里！nox 将在检出项目的 .nox 中创建虚拟环境，并安装运行测试所需的依赖项。

antsibull-core 依赖于姐妹项目 antsibull-fileutils。默认情况下，nox 将从 Github 安装此项目的开发版本。如果您在 antsibull-core 旁边修改 antsibull-fileutils，当运行测试且此路径存在时，nox 将自动从 ../antsibull-fileutils 安装此项目。您可以通过 OTHER_ANTSIBULL_MODE 环境变量更改此行为。

• OTHER_ANTSIBULL_MODE=auto — 如上所述的默认行为
• OTHER_ANTSIBULL_MODE=local — 从 ../antsibull-fileutils 安装项目。如果此路径不存在，则失败。
• OTHER_ANTSIBULL_MODE=git — 从 Github 的主分支安装项目
• OTHER_ANTSIBULL_MODE=pypi — 从 PyPI 安装最新版本

运行特定测试

1. nox -e test 仅运行单元测试；
2. nox -e coverage 在运行 nox -e test 之后显示组合覆盖率结果；
3. nox -e lint 同时运行所有 linters 和格式化程序；
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_core/__init__.py 中增加包版本。
   • 创建包含 release_summary 节的 changelogs/fragments/<version>.yml。
   • 运行 antsibull-changelog release 并将更改的文件添加到 git 中。
   • 使用消息 发布 <version> 提交更改，并运行 git tag -a -m 'antsibull-core <version>' <version>。
   • 运行 hatch build。
2. 运行 git push 到适当的远程仓库。
3. 一旦 GitHub 上的 CI 通过，运行 nox -e publish。这
   • 运行 hatch publish；
   • 将版本增加到 <version>.post0；
   • 将更改的文件添加到 git 并运行 git commit -m '发布后版本增加.'；
4. 运行 git push --follow-tags 到适当的远程仓库并创建 GitHub 发布。

许可证

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

代码的部分来自其他来源，并使用其他许可证授权。

1. src/antsibull_core/vendored/collections.py 和 src/antsibull_core/vendored/json_utils.py 在 BSD 2-Clause 许可证下授权。请参阅 LICENSES/BSD-2-Clause.txt 获取许可证副本。
2. tests/functional/aiohttp_utils.py 和 tests/functional/certificate_utils.py 在 MIT 许可证下授权。请参阅 LICENSES/MIT.txt 获取许可证副本。
3. src/antsibull_core/vendored/_argparse_booleanoptionalaction.py 在 Python 软件基金会许可证版本 2 下授权。请参阅 LICENSES/PSF-2.0.txt 获取许可证副本。

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