Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 1.32 KB

RELEASE.md

File metadata and controls

59 lines (44 loc) · 1.32 KB
Raw

Release Workflow

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

1. AUTHORS

Update the AUTHORS and .mailmap file

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

2. 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

3. Version

Version numbers are incremented regarding the SemVer 1.0.0 specification. Update the version number in metadata.json.

4. Git Tag

Commit all changes to the master branch

git commit -v -a -m "Release version <VERSION>"
git push

Tag the release

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

Push tags

git push --tags

Puppet Forge

The module is uploaded automatically to Puppet Forge by TravisCI when a new tag is set.