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