贡献集合
如果你想向现有集合添加功能,修改你正在使用的集合以修复错误,或更改集合中模块的行为,请克隆该集合的 Git 仓库并在分支上进行更改。你可以将对集合的更改与 Ansible 的本地检出相结合(source hacking/env-setup
)。你应该首先检查集合仓库以查看它是否具有特定的贡献指南。这些通常列在仓库中的 README.md 或 CONTRIBUTING.md 文件中。请参阅 创建你的第一个集合拉取请求 获取更一般的指南,并参阅 测试 Ansible 和集合 获取测试指南。
贡献集合:community.general
这些说明适用于托管在 ansible_collections GitHub 组织 中的集合。对于其他集合,特别是对于不在 GitHub 上托管的集合,请检查集合的 README.md
以获取有关如何为其贡献代码的信息。
此示例使用 community.general 集合。要为同一 GitHub 组织中的其他集合贡献代码,请将文件夹名称 community
和 general
替换为不同集合的命名空间和集合名称。
先决条件
在 COLLECTIONS_PATHS 中包含
~/dev/ansible/collections/
如果该路径提到了多个目录,请确保搜索路径中较早的任何其他目录都不包含
community.general
的副本。
创建 PR
创建目录
~/dev/ansible/collections/ansible_collections/community
mkdir -p ~/dev/ansible/collections/ansible_collections/community
克隆 community.general Git 仓库 或其分支到
general
目录
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
创建一个分支并在该分支上提交你的更改。
请记住为你的更改添加测试,请参阅 测试集合。
将你的更改推送到你的集合分支并创建一个拉取请求。
你可以通过在 playbook 和角色中使用此 community.general
的检出版本以及你本地安装的任何 Ansible 版本(包括 ansible/ansible
的 devel
分支的本地检出)来测试你的更改。
另请参阅
- 使用 Ansible 集合
学习如何安装和使用集合。
- 为 Ansible 维护的集合贡献代码
为选定的集合贡献代码的指南
- 沟通
有问题?需要帮助?想分享你的想法?请访问 Ansible 沟通指南