Skip to content

Latest commit

 

History

History
84 lines (68 loc) · 1.86 KB

RELEASE.md

File metadata and controls

84 lines (68 loc) · 1.86 KB

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. Puppet Development Kit

If not installed, please install the PDK and do a 'bundle install'.

cd icingadb
pdk bundle install

Or if already installed do an update.

cd icingadb
pdk bundle update

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

3. Reference

If it is not installed [puppet-strings]:

gem install puppet-strings --no-ri --no-rdoc

Generate [REFERENCE.md] via Puppet Strings

puppet strings generate --format markdown --out ./REFERENCE.md

4. Version

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

5. Changelog

Install github-changelog-generator

gem install github_changelog_generator -v 1.13.2

Generate CHANGELOG.md

github_changelog_generator -t <github-access-token> --future-release=v1.0.0 -u icinga -p puppet-icingadb

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

7. Build and Upload

pdk build

Upload the tarball to Puppet Forge.