Clarify SCM and release requirements (#218)

* Require git repos * Clarify tagging and releasing Co-authored-by: Maxwell G <9920591+gotmax23@users.noreply.github.com> Co-authored-by: Maxwell G <9920591+gotmax23@users.noreply.github.com>
ansible-collections · Oct 26, 2022 · 6dbb503 · 6dbb503
1 parent 24343d3
commit 6dbb503
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/collection_checklist.md b/collection_checklist.md
@@ -11,7 +11,7 @@ Note for reviewers: If you don't know how to check any of the points below, plea
 - [ ] has a policy of releasing, versioning and deprecation announced to contributors and users in some way
 - [ ] have a Code of Conduct (CoC) compatible with the [Ansible Code of Conduct (CoC)](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
 - [ ] have a publicly available issue tracker that does not require a paid level of service to create an account or view issues
-- [ ] have a public SCM repository, releases of the collection are tagged in this repository
+- [ ] have a public git repository, releases of the collection are tagged in this repository
 
 **Standards and documentation:**
 - [ ] adheres to [semantic versioning](https://semver.org/)

diff --git a/collection_requirements.rst b/collection_requirements.rst
@@ -280,7 +280,11 @@ licensing and legal concerns that may otherwise affect your code.
 Repository management
 =====================
 
-Every collection MUST have a public SCM repository and releases of the collection MUST be tagged in this repository.
+Every collection MUST have a public git repository. Releases of the collection MUST be tagged in said repository. This means that releases MUST be ``git tag``ed and that the tag name MUST exactly match the Galaxy version number. Tag names MAY have a ``v`` prefix, but a collection's tag names MUST have a consistent format from release to release.
+
+Additionally, collection artifacts released to Galaxy MUST be built from the sources that are tagged in the collection's git repository as that release. Any changes made during the build process MUST be clearly documented so the collection artifact can be reproduced.
+
+We are open to allowing other SCM software once our tooling supports them.
 
 Branch name and configuration
 -----------------------------