RELEASE.md

Release Workflow

Before submitting a new release, make sure all relevant pull requests and local branches have been merged to the devel branch. All tests must pass before a release is tagged.

1. Testing

Make sure tests pass before starting with a release. See TESTING.md for more information.

2. Authors

Update the AUTHORS and .mailmap file

git checkout devel
git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
git commit -am "Update AUTHORS"

3. Changelog

Install github-changelog-generator

gem install github_changelog_generator

Generate CHANGELOG.md

github_changelog_generator -t <github-access-token> --future-release=v1.0.0

4. Git Tag

Merge all changes to the master branch

Now tag the release

git tag -m "Version <VERSION>" v<VERSION>

Push tags

git push --tags

Ansible Galaxy

The role is uploaded automatically to Ansible Galaxy.