将 Ansible 内容迁移到不同的集合

您可能决定将内容从一个集合移动到另一个集合；例如，将一组相关模块从 community.general 或 community.network 中提取出来，以创建一个更集中的集合。当您在集合之间迁移内容时，必须采取某些步骤来确保用户能够跟踪过渡。

迁移内容 

如果要从中迁移内容的集合包含在 Ansible 社区包中，请确保目标集合满足 Ansible 社区包集合要求。在满足要求后，您可以按照以下步骤迁移内容

将内容从源（旧）集合复制到目标（新）集合。
更改 M()、示例、seealso、extended_documentation_fragments 以在移动的内容、旧集合以及引用该内容的其他集合中使用实际的 FQCN。
移动所有相关的 issue、pull 请求和 wiki 页面。
浏览 ansible-documentation GitHub 存储库的 docs/docsite 目录（例如，使用 grep 命令行实用程序）以检查是否存在使用移动的模块和插件的示例，以便您可以更新这些 FQCN。
在旧集合的 meta/runtime.yml 中使用 removal_version 使模块/插件过时，并将其计划在下一个主要版本中删除。在将复制的内容包含在新集合的版本中之后，必须发布过时版本。
当准备发布旧集合的下一个主要版本时

从旧集合中删除模块/插件

删除相关的单元和集成测试

删除特定模块实用程序（如果它们没有被其他模块/插件或 module_utils 使用）

如果旧集合中存在特定文档片段，请将其删除

添加一个包含 removed_features 和 breaking_changes 条目的变更日志片段；您可以在此 pull 请求中看到变更日志片段的示例

更改旧集合中的 meta/runtime.yml

将 redirect 添加到相应模块/插件的条目

特别是，如果适用，请为已删除的模块实用程序和文档片段添加 redirect

从那里删除 removal_version

如果存在，请从 tests/sanity/ignore.txt 文件中删除相关条目

删除尚未包含在变更日志中的已删除内容的相关变更日志片段（换句话说，不要修改 changelogs/changelog.yaml 也不要删除其中提到的文件）

从 tests/unit/requirements.txt、tests/requirements.yml 和 galaxy.yml 中删除不再需要的要求

要实现这些更改，您需要创建至少三个 PR

创建针对新集合的 PR 以复制内容。
在旧集合中使模块/插件过时。
稍后创建针对旧集合的 PR，根据计划删除内容。

将内容添加到新集合 

在新集合中创建 PR

从旧集合中复制所有相关文件。
如果是操作插件，请包含相应的模块及其文档。
如果是模块，请检查它是否具有相应的操作插件，该插件应与其一起移动。
如果存在，请检查 meta/ 以了解对 runtime.yml 的相关更新。
仔细检查移动的 tests/integration 和 tests/units，并针对 FQCN 进行更新。
查看旧集合中的 tests/sanity/ignore-*.txt 条目。
更新旧集合中的 meta/runtime.yml。

从旧集合中删除内容 

创建针对源集合存储库的 PR，以删除与这次迁移相关的模块、module_utils、插件和 docs_fragments

如果要删除操作插件，请删除包含文档的相应模块。
如果要删除模块，请删除任何相应的操作插件，这些插件应该与其保持一致。
从 meta/runtime.yml 中删除有关已删除插件的任何条目。确保将它们添加到新存储库中。
从 tests/sanity/ignore\*.txt 中删除相关的健全性忽略行
从 tests/integrations/targets/ 中删除相关的集成测试，从 tests/units/plugins/ 中删除单元测试。
如果要从 community.general 或 community.network 中删除内容，请从 .github/BOTMETA.yml 中删除条目。
仔细查看 meta/runtime.yml，以查看可能需要删除或更新的任何条目，特别是过时的条目。
更新 meta/runtime.yml 以包含指向每个插件的重定向，指向新集合名称。

警告

旧集合的维护人员必须确保 PR 的合并方式不会破坏用户体验和语义版本控制

包含合并的 PR 的新版本不能在包含该内容的集合再次发布之前发布。否则，重定向将无法正常工作，依赖该内容的用户将遇到问题。
一旦删除内容的集合的 1.0.0 版本发布，此类 PR 只能合并到新的 **主要** 版本中（换句话说，2.0.0、3.0.0 等）。

更新 BOTMETA.yml 

例如，在 community.general 集合存储库中的 BOTMETA.yml 是以下内容的真实来源

ansibullbot

如果旧集合和/或新集合具有 ansibullbot，则必须相应地更新其 BOTMETA.yml。

Ansibulbot 将知道如何将现有 issue 和 PR 重定向到新的存储库。docs.ansible.com 的构建过程将知道从哪里查找模块文档。

$modules/monitoring/grafana/grafana_plugin.py:
    migrated_to: community.grafana
$modules/monitoring/grafana/grafana_dashboard.py:
    migrated_to: community.grafana
$modules/monitoring/grafana/grafana_datasource.py:
    migrated_to: community.grafana
$plugins/callback/grafana_annotations.py:
    maintainers: $team_grafana
    labels: monitoring grafana
    migrated_to: community.grafana
$plugins/doc_fragments/grafana.py:
    maintainers: $team_grafana
    labels: monitoring grafana
    migrated_to: community.grafana

示例 PR

必须为每个 *文件* 明确添加 migrated_to: 键。您不能在目录级别添加 migrated_to。这样做是为了允许模块和插件 webdocs 重定向到新的集合文档。
必须为每个以下内容添加 migrated_to
- 模块
- 插件
- module_utils
- contrib/inventory 脚本
您不需要为以下内容添加 migrated_to
- 单元测试
- 集成测试
- ReStructured Text 文档（docs/docsite/rst/ 下的任何内容）
- ansible/ansible:devel 中从未存在的文件

另请参阅

使用 Ansible 集合: 了解如何安装和使用集合。
为 Ansible 维护的集合贡献力量: 为选定集合贡献力量的指南
沟通: 有问题？需要帮助？想要分享你的想法？访问 Ansible 沟通指南

将 Ansible 内容迁移到不同的集合

迁移内容

将内容添加到新集合

从旧集合中删除内容

更新 BOTMETA.yml

迁移内容 

将内容添加到新集合 

从旧集合中删除内容 

更新 BOTMETA.yml 