Commit Checks

Prerequisites

• Ansible Environment.

Ensure all TODOs are valid

grep -ri todo

Ensure linting follows guidelines

grep -ri yamllint  # yamllint
grep -ri noqa  # ansible-lint

Lint returns clean

yamllint .
ansible-lint .

Reference:

• https://yamllint.readthedocs.io/en/stable/
• https://ansible.readthedocs.io/projects/lint/rules/

Add collection ignore files

Add files that should not be included in the built collection such as tests.

galaxy.yml

build_ignore:
  - .gitignore
  - changelogs/.plugin-cache.yaml

Reference:

• https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_distributing.html#ignoring-files-and-folders

Update collection submodule reference

Required otherwise the collection will not use the updated module on checkout.

See submodule Updates and Commit

Versioning

Only tag versions when a new release is ready. See Major Release Guide.

Track Project Updates

• Always link to the latest release (or release page).
• Set alerts to check for new release (or push notifications) for each role.

Build Galaxy Release

ansible-galaxy collection build
ansible-galaxy collection publish  # Alternatively manually upload to Galaxy.

Reference:

• https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_creating.html