为集合贡献

如果您想向现有集合添加功能、修改您正在使用的集合以修复错误,或更改集合中模块的行为,请克隆该集合的 Git 存储库并在分支上进行更改。您可以将对集合的更改与 Ansible 的本地检出合并在一起(source hacking/env-setup)。您应该首先检查集合存储库以查看它是否有特定的贡献指南。这些通常列在存储库中的 README.md 或 CONTRIBUTING.md 文件中。有关更一般的指南,请参见 创建您的第一个集合拉取请求,有关测试指南,请参见 测试 Ansible 和集合

为集合贡献:community.general

这些说明适用于托管在 ansible_collections GitHub 组织 中的集合。对于其他集合,特别是对于未托管在 GitHub 上的集合,请检查集合的 README.md 以了解有关为其贡献的信息。

此示例使用 community.general 集合。要为同一 GitHub 组织中的其他集合贡献,请将文件夹名称 communitygeneral 替换为不同集合的命名空间和集合名称。

先决条件

  • ~/dev/ansible/collections/ 包含在 COLLECTIONS_PATHS

  • 如果该路径提到了多个目录,请确保搜索路径中较早的目录不包含 community.general 的副本。

创建 PR

  • 创建目录 ~/dev/ansible/collections/ansible_collections/community

mkdir -p ~/dev/ansible/collections/ansible_collections/community
cd ~/dev/ansible/collections/ansible_collections/community
git clone [email protected]:ansible-collections/community.general.git general
  • 如果您从分支克隆,请将原始存储库添加为远程 upstream

cd ~/dev/ansible/collections/ansible_collections/community/general
git remote add upstream [email protected]:ansible-collections/community.general.git
  • 创建一个分支并在分支上提交您的更改。

  • 请记住为您的更改添加测试,请参见 测试集合

  • 将您的更改推送到您对集合的分支并创建一个拉取请求。

您可以通过在剧本和角色中使用此 community.general 的检出,以及您在本地安装的任何 Ansible 版本(包括 ansible/ansibledevel 分支的本地检出),来测试您的更改。

另请参见

使用 Ansible 集合

了解如何安装和使用集合。

为 Ansible 维护的集合贡献

为选定集合贡献的指南

沟通

有问题吗?需要帮助?想分享你的想法?请访问 Ansible 沟通指南