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

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

迁移内容 

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

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

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

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

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

删除旧集合中任何特定的文档片段

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

更改旧集合中的 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 

例如，BOTMETA.yml（例如在 community.general 集合仓库中）是以下内容的真实来源：

ansibullbot

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

Ansibulbot 将知道如何将现有问题和 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。这是为了允许将模块和插件的 Web 文档重定向到新集合文档。
必须为每个以下内容添加 migrated_to:
- 模块
- 插件
- module_utils
- contrib/inventory 脚本
你不需要为以下内容添加 migrated_to：
- 单元测试
- 集成测试
- ReStructured Text 文档（docs/docsite/rst/ 下的任何内容）
- 从未在 ansible/ansible:devel 中存在的文件

另请参阅

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

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

迁移内容

将内容添加到新的集合

从旧的集合中删除内容

更新 BOTMETA.yml

迁移内容 

将内容添加到新的集合 

从旧的集合中删除内容 

更新 BOTMETA.yml 