将 Ansible 内容迁移到另一个集合

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

迁移内容 

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

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

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

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

删除特定的模块实用程序（如果它们没有被其他模块/插件或 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 文件。

$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

Ansibulbot 将知道如何将现有问题和 PR 重定向到新仓库。docs.ansible.com 的构建流程将知道在哪里查找模块文档。

示例 PR
对于每个文件，必须显式添加 migrated_to: 键。您不能在目录级别添加 migrated_to。这是为了允许将模块和插件的 Web 文档重定向到新的集合文档。
- migrated_to: 必须添加到每个
- 模块
- 插件
- module_utils
contrib/inventory 脚本
- 您无需为以下内容添加 migrated_to：
- 单元测试
- 集成测试
- ReStructured Text 文档（docs/docsite/rst/ 下的任何内容）

在 ansible/ansible:devel 中从未存在的文件

使用 Ansible 集合: 另请参阅
了解如何安装和使用集合。: 为 Ansible 维持的集合贡献
为选定集合贡献的指南: 沟通

将 Ansible 内容迁移到另一个集合

迁移内容

将内容添加到新集合中

从旧集合中删除内容

更新 BOTMETA.yml

迁移内容 

将内容添加到新集合中 

从旧集合中删除内容 

更新 BOTMETA.yml 