This repository is used for requests to include new collections into the ansible package. Take a look at the Ansible collection creator path that covers important aspects your collection must have implemented in order to be considered a candidate for inclusion.
We use GitHub Discussions feature to track these requests.
Regular community reviewers will be offered to join the Ansible Community Steering Committee.
See the Collection inclusion policy to learn how the collection inclusion process works.
New collections can be included in every minor release of the ansible package. These happen roughly every three weeks.
For new major releases (X.0.0), new collections have to be added before the feature freeze. If they miss feature freeze, they have to wait for the next minor release (X.1.0). Deadlines for the ansible package can be found in the ansible roadmaps.
The Ansible docsite, the devel version, will refer to a collection's documentation within a day after the collection inclusion is done. The latest version will show the references after the following Ansible release.
All new collections submitted for inclusion MUST satisfy the Collection Requirements. Before submitting, please appreciate the time of volunteer reviewers by making sure your collection satisfies the requirements.
If there are any questions, feel free to ask for clarifications in the discussion described below and/or in the #ansible-community Matrix/IRC channel.
- Review one of the collections submitted for inclusion by other developers in the following categories:
This step is optional but it can significantly reduces the time for your collection to get in (finally it will depend on your collection's quality) because:
- You will gain experience when reviewing someone else's collection. It will allow you to make your collection better before submitting it and will save your and reviewer's time and effort as there will probably be fewer issues to fix.
- The Steering Committee will handle your request with a higher priority.
You can also offer your help with reviewing other's requests after you submit your collection.
See the Review process section to learn more.
- Start a GitHub Discussion in the new collection review category. Please copy the following into your initial message (only after you carefully read and make your collection satisfying the Collection Requirements):
Two or three sentence description of your collection.
Ansible Galaxy: https://galaxy.ansible.com/NAMESPACE/COLLECTION
GitHub: https://github.com/ORG/REPONAME
Issues Tracker: https://github.com/ORG/REPONAME/issues
GitHub Handles:
Is the collection part of Automation Hub: Yes/Soon/No
We meet [Collection Requirements](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html): Yes/No
In case the repository is not on GitHub, please provide email addresses.
If you reviewed someone else's collection, please specify it too.
- Ensure any other maintainers of the collection are
@mentionedin the discussion so they will receive updates. - Promptly reply to any questions.
- Choose a review request from the New collection reviews or Second review needed categories. Give a higher priority to collections whose maintainers reviewed someone else's collection (see discussion descriptions for this information).
- Copy the Review checklist into the request.
- Go through the checklist:
- Mark bullet points as complete when a collection satisfies the requirements.
- If the collection does not satisfy a requirement, add
MUST FIX:below the corresponding bullet point + an action needed from collection maintainers. - If the collection satisfies a requirement but the implementation can be improved, add
SHOULD FIX:+ an action needed. - If you have questions to maintainers, add
COMMENT:+ your question.
See the complete example.