Documentation for the collection.
- Build the collection (see below, in 'releasing' section).
VERSION=1.0.0 ansible-galaxy collection install evrardjp-ha-$VERSION.tar.gz -p ./collections
`ansible-galaxy collection install git+https://github.com/evrardjp/ansible-collection-ha.git,main
- Create a new branch in your own fork of this collection.
- Define ROLENAME, ROLE_GIT_REPO_URL, ROLE_GIT_REPO_BRANCH for your case
- Run the following command:
git subtree add --prefix roles/$ROLENAME $ROLE_GIT_REPO_URL $ROLE_GIT_REPO_BRANCH --squash
- replace the "add" in previous command by "pull", and add that line into the
update-upstream.sh
shell script. git add update-upstream.sh, git commit. - Push to your own fork your 3 commits (those two commits should be generated for you by git in step 2).
- Submit a PR.
- run the
update-upstream.sh
. This will update the code for the roles. - Read the changes into the roles. Bump the version of the galaxy in
galaxy.yml
if necessary.
Currently, only evrardjp has the rights to do this. If you want those rights, please contact him.
- Run
ansible-galaxy collection build
- Check that the version generated looks correct (not duplicate of an existing version, and version number is matching expectations described below). It's useful in case someone forgot to bump the collection version number.
- Run
ansible-galaxy collection publish
https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_structure.html
This is not yet implemented. The intent is to use https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_changelogs.html .
Currently, the only documentation is this README.