Ansible 开发周期

Ansible 开发人员（包括社区贡献者）在许多不同的存储库中添加新功能、修复错误并更新代码。 ansible/ansible 存储库包含基本功能和函数的代码，例如将模块代码复制到被管理节点。此代码也称为 ansible-core。其他存储库包含插件和模块，使 Ansible 能够执行特定任务，例如向特定数据库添加用户或配置特定网络设备。这些存储库包含集合的源代码。

对 ansible-core 的开发发生在两个层次上。在宏观层面上，ansible-core 开发人员和维护人员计划版本发布并使用路线图和项目跟踪进度。在微观层面上，每个 PR 都有自己的生命周期。

集合的开发也发生在宏观和微观层面。每个集合都有自己的宏观开发周期。有关集合开发周期的更多信息，请参阅为 Ansible 维护的集合贡献代码。PR 的微观层级生命周期在集合和 ansible-core 中类似。

宏观开发：`ansible-core`路线图、版本发布和项目 

如果你想关注关于哪些功能将添加到 ansible-core 以用于即将发布的版本以及正在修复哪些错误的讨论，你可以关注以下资源

ansible-core 路线图
Ansible 版本发布计划
ansible-core 项目分支和标签
各种 GitHub 项目 - 例如
- 2.17 版本发布项目
- 核心文档项目

微观开发：PR 的生命周期 

如果你想为 ansible-core 或集合贡献功能或修复错误，你必须打开一个**拉取请求**（简称“PR”）。GitHub 提供了一个关于拉取请求过程如何工作的总体概述。任何拉取请求的最终目标都是合并并成为集合或 ansible-core 的一部分。以下是 PR 生命周期概述

贡献者打开一个 PR（始终针对 devel 分支）
ansible-core 使用 Ansibot 来分类 PR。一些集合存储库使用 Ansibullbot 来分类 PR。对于大多数集合，这是手动完成或通过其他方式完成的。
Azure Pipelines 运行测试套件
开发人员、维护人员、社区审查 PR
贡献者解决审阅者提供的任何反馈
开发人员、维护人员、社区重新审查
PR 合并或关闭
PR 回退到一个或多个 stable-X.Y 分支（可选，仅限错误修复）

使你的 PR 值得合并 

我们不会合并每个 PR。以下是一些使你的 PR 有用、有吸引力和值得合并的技巧。

创建变更日志片段 

变更日志帮助用户和开发人员了解 ansible-core 和 Ansible 集合的更改。Ansible 和许多集合从片段构建每个版本的变更日志。对于使用此模型的 ansible-core 和集合，你**必须**向任何更改功能或修复错误的 PR 添加变更日志片段。

对于以下 PR，你不需要变更日志片段：

添加新的模块和插件，因为 Ansible 工具会自动执行此操作；
仅包含文档更改。

注意

一些集合要求每个拉取请求都包含一个变更日志片段。它们使用 trivial: 部分用于上面提到的在构建版本发布变更日志时将跳过的条目。

更准确地说

每个错误修复 PR 都必须包含一个变更日志片段。唯一的例外是修复尚未包含在版本发布中的更改。
每个功能 PR 都必须包含一个变更日志片段。
新的模块和插件（包括 jinja2 过滤器和测试插件）必须在其文档中正确设置 version_added 条目，并且不需要变更日志片段。工具通过其 version_added 值检测新的模块和插件，并在下一个版本的变更日志中自动宣布它们。

我们为次要版本发布和主要版本发布构建简短的摘要变更日志。如果你回退错误修复，请在回退 PR 中包含一个变更日志片段。

一个基本的变更日志片段是一个放置在 changelogs/fragments/ 目录中的 .yaml 或 .yml 文件。每个文件包含一个 yaml 字典，其中包含 bugfixes 或 major_changes 等键，后跟错误修复或功能的变更日志条目的列表。每个变更日志条目都是嵌入在 yaml 文件内的 rst，这意味着某些结构需要转义，以便它们可以被 rst 解释而不是被 yaml 解释（或者如果你愿意，可以同时转义 yaml 和 rst）。每个 PR **必须**使用新的片段文件，而不是添加到现有的文件中，这样我们就可以将更改追溯到引入它的 PR。

添加新模块或插件的 PR 不一定需要变更日志片段。请参阅上一节创建变更日志片段。另请参阅下一节变更日志片段条目格式，了解变更日志片段应具有的精确格式。

要创建变更日志条目，请在相应存储库的 changelogs/fragments/ 目录中创建一个具有唯一名称的新文件。文件名应包含 PR 编号和更改说明。它必须以文件扩展名 .yaml 或 .yml 结尾。例如：40696-user-backup-shadow-file.yaml

单个变更日志片段可能包含多个部分，但大多数只包含一个部分。顶级键（bugfixes、major_changes 等）在配置文件中定义，用于我们的版本发布说明工具。以下是有效的部分以及每个部分的描述

breaking_changes

**必须**包含破坏现有 playbook 或角色的更改。这包括对现有行为的任何更改，这些更改会强制用户更新任务。破坏性更改意味着用户在更新时**必须**进行更改。破坏性更改**必须**仅发生在集合的主要版本发布中。用现在时态写作，并清楚地描述最终用户现在必须遵循的新行为。显示在变更日志和移植指南中。

breaking_changes:
  - ansible-test - automatic installation of requirements for cloud test plugins no longer occurs. The affected test plugins are ``aws``, ``azure``, ``cs``, ``hcloud``, ``nios``, ``opennebula``, ``openshift`` and ``vcenter``. Collections should instead use one of the supported integration test requirements files, such as the ``tests/integration/requirements.txt`` file (https://github.com/ansible/ansible/pull/75605).

major_changes

对 ansible-core 或集合的主要更改。**不应**包含单个模块或插件更改。**必须**包含影响集合全部或大部分内容的非破坏性更改（例如，更新以支持整个集合的新 SDK 版本）。主要更改意味着用户可以选择在更新时进行更改，但不必更改。可以用来宣布未来版本发布中重要的即将到来的 EOL 或破坏性更改。（理想情况下提前 6 个月，如果已知。请参阅此示例）。用现在时态写作并描述新增内容。可选地，包括一个“以前……”句子以帮助用户识别现在应更改旧行为的位置。显示在变更日志和移植指南中。

major_changes:
  - ansible-test - all cloud plugins which use containers can now be used with all POSIX and Windows hosts. Previously the plugins did not work with Windows at all, and support for hosts created with the ``--remote`` option was inconsistent (https://github.com/ansible/ansible/pull/74216).

minor_changes

对 ansible-core、模块或插件的次要更改。这包括添加到模块的新参数，或对现有参数的非破坏性行为更改，例如向 choices[] 添加其他值。次要更改是增强功能，而不是错误修复。用现在时态写作。

minor_changes:
  - lineinfile - add warning when using an empty regexp (https://github.com/ansible/ansible/issues/29443).

deprecated_features

将在未来版本中弃用并计划删除的功能。使用过去时态，并在可用情况下包含对已弃用内容的替代方案。在变更日志和移植指南中显示。

deprecated_features:
  - include action - is deprecated in favor of ``include_tasks``, ``import_tasks`` and ``import_playbook`` (https://github.com/ansible/ansible/pull/71262).

removed_features

先前已弃用且现已删除的功能。使用过去时态，并在可用情况下包含对已弃用内容的替代方案。在变更日志和移植指南中显示。

removed_features:
  - _get_item() alias - removed from callback plugin base class which had been deprecated in favor of ``_get_item_label()`` (https://github.com/ansible/ansible/pull/70233).

security_fixes

解决 CVE 或安全问题的修复。对于任何 CVE，**必须**使用 security_fixes。使用现在时态。包含指向 CVE 信息的链接。

security_fixes:
  - set_options -do not include params in exception when a call to ``set_options`` fails. Additionally, block the exception that is returned from being displayed to stdout. (CVE-2021-3620).

bugfixes

解决问题的修复。**不应**用于轻微的增强（改为使用minor_change）。使用过去时态描述问题，使用现在时态描述修复。

bugfixes:
  - ansible_play_batch - variable included unreachable hosts. Fix now saves unreachable hosts between plays by adding them to the PlayIterator's ``_play._removed_hosts`` (https://github.com/ansible/ansible/issues/66945).

known_issues

当前未修复或不会修复的已知问题。使用现在时态，并在可用情况下，使用祈使句表示解决方法。

known_issues:
  - ansible-test - tab completion anywhere other than the end of the command with the new composite options provides incorrect results (https://github.com/kislyuk/argcomplete/issues/351).

每个变更日志条目必须在其末尾包含指向其问题的链接（在括号内）。如果没有相应的 issue，则条目必须包含指向 PR 本身的链接。

大多数变更日志条目为bugfixes或minor_changes。变更日志工具还支持trivial，这些条目未列在实际的变更日志输出中，但由需要每个 PR 的变更日志片段的集合存储库使用。

变更日志片段条目格式 

编写变更日志条目时，请使用以下格式

- scope - description starting with a lowercase letter and ending with a period at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).

范围通常是模块或插件名称或模块或插件组，例如lookup plugins。虽然可以直接提及模块名称（并且应该提及）（foo_module），但插件名称后面始终应跟类型（foo inventory plugin）。

对于范围不大的更改（例如，影响整个集合的更改），请使用以下格式

- Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself).

以下是一些示例

bugfixes:
  - apt_repository - fix crash caused by ``cache.update()`` raising an ``IOError``
    due to a timeout in ``apt update`` (https://github.com/ansible/ansible/issues/51995).

minor_changes:
  - lineinfile - add warning when using an empty regexp (https://github.com/ansible/ansible/issues/29443).

bugfixes:
  - copy - the module was attempting to change the mode of files for
    remote_src=True even if mode was not set as a parameter.  This failed on
    filesystems which do not have permission bits (https://github.com/ansible/ansible/issues/29444).

您可以在 2.17 版本的变更日志目录中找到更多示例变更日志片段。

在为您的 PR 编写变更日志片段后，提交文件并将其包含在拉取请求中。

新剧本的变更日志片段条目格式 

虽然生成的变更日志会自动提及新的模块、插件和角色，但不会提及剧本。为了确保提及它们，需要使用特定格式的变更日志片段

# A new playbook:
add object.playbook:
  - # This should be the short (non-FQCN) name of the playbook.
    name: wipe_server
    # The description should be in the same format as short_description for
    # plugins and modules: it should start with an upper-case letter and
    # not have a period at the end.
    description: Wipes a server

在`ansible-core`中回传合并的 PR 

所有ansible-core PR 必须首先合并到devel分支。在拉取请求被接受并合并到devel分支后，以下说明将帮助您创建拉取请求以将更改回传到以前稳定的分支。

我们**不会**回传功能。

注意

这些说明假设

stable-2.17 是回传的目标发布分支

https://github.com/ansible/ansible.git 配置为名为upstream的git remote。如果您不使用名为upstream的git remote，请相应调整说明。

https://github.com/<yourgithubaccount>/ansible.git 配置为名为origin的git remote。如果您不使用名为origin的git remote，请相应调整说明。

准备您的 devel、stable 和 feature 分支

git fetch upstream
git checkout -b backport/2.17/[PR_NUMBER_FROM_DEVEL] upstream/stable-2.17

将相关提交 SHA 从 devel 分支 cherry-pick 到您的 feature 分支，根据需要处理合并冲突

git cherry-pick -x [SHA_FROM_DEVEL]

添加更改的变更日志片段，并提交。
将您的 feature 分支推送到您在 GitHub 上的分支。

git push origin backport/2.17/[PR_NUMBER_FROM_DEVEL]

针对stable-2.17分支提交backport/2.17/[PR_NUMBER_FROM_DEVEL]的拉取请求
发布经理将在下一个次要版本发布之前决定是否合并回传 PR。无需跟进。只需确保自动化测试 (CI) 通过即可。

注意

分支名称backport/2.17/[PR_NUMBER_FROM_DEVEL]在某种程度上是任意的，但传达了有关分支目的的信息。此分支名称格式不是必需的，但它可能很有帮助，尤其是在为多个稳定分支创建多个回传 PR 时。

注意

如果您愿意，可以使用 CPython 的 cherry-picker 工具（pip install --user 'cherry-picker >= 1.3.2'）将提交从 devel 回传到 Ansible 中的稳定分支。请查看cherry-picker 文档，了解有关安装、配置和使用它的详细信息。