icinga2/RELEASE.md

4.2 KiB

Release Workflow

Specify the release version.

VERSION=2.7.0

Issues

Check issues at https://github.com/Icinga/icinga2

Backport Commits

For minor versions you need to manually backports any and all commits from the master branch which should be part of this release.

Authors

Update the .mailmap and AUTHORS files:

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

Version

Fetch the latest spec file from the icinga-packaging repository and verify that the latest version is set.

wget -O icinga2.spec https://raw.githubusercontent.com/Icinga/icinga-packaging/rpm/snapshot/icinga2/icinga2.spec
gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec

Changelog

Update the CHANGELOG.md file.

Export these environment variables:

export ICINGA_GITHUB_AUTH_USERNAME='user'
export ICINGA_GITHUB_AUTH_TOKEN='token'
export ICINGA_GITHUB_PROJECT='icinga/icinga2'

Run the script which updates the CHANGELOG.md file.

./changelog.py
git diff

Git Tag

Commit these changes to the "master" branch:

git commit -v -a -m "Release version $VERSION"

For minor releases: Cherry-pick this commit into the "support" branch.

Create a signed tag (tags/v) on the "master" branch (for major releases) or the "support" branch (for minor releases).

GB:

git tag -u EE8E0720 -m "Version $VERSION" v$VERSION

MF:

git tag -u D14A1F16 -m "Version $VERSION" v$VERSION

Push the tag.

git push --tags

For major releases: Create a new "support" branch:

git checkout master
git checkout -b support/2.7
git push -u origin support/2.7

For minor releases: Push the support branch, cherry-pick the release commit into master and merge the support branch:

git push -u origin support/2.7
git checkout master
git cherry-pick support/2.7
git merge --strategy=ours support/2.7
git push origin master

External Dependencies

Build Server

  • Verify package build changes for this version.
  • Test the snapshot packages for all distributions beforehand.
  • Build the newly created Git tag for Debian/RHEL/SuSE.
  • Build the newly created Git tag for Windows.

Release Tests

  • Test DB IDO with MySQL and PostgreSQL.

  • Provision the vagrant boxes and test the release packages.

  • Test the setup wizard inside a Windows VM.

  • Start a new docker container and install/run icinga2.

Example for CentOS7:

docker run -ti centos:latest bash

yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
yum -y install icinga2
icinga2 daemon -C

GitHub Release

Create a new release for the newly created Git tag. https://github.com/Icinga/icinga2/releases

Chocolatey

Navigate to the git repository on your Windows box which already has chocolatey installed. Pull/checkout the release.

Create the nupkg package:

cpack

Install the created icinga2 package locally:

choco install icinga2 -version 2.7.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"

Upload the package to chocolatey.

Online Documentation

Edit config.yml in the icinga-docs-tools repository:

git clone git@github.com:Icinga/icinga-docs-tools.git
cd icinga-docs-tools/
vim config.yml

git commit -av -m "Update to Icinga 2 v$VERSION"
git push

SSH into the web VM and build the docs:

cd /var/www/docs/icinga-docs/latest/
/usr/bin/bundle exec ./build-docs.rb

Announcement

After the release

  • Add new minor version on GitHub.
  • Close the released version on GitHub.