icinga2/RELEASE.md

Release Workflow

Table of Content

• 1. Preparations
  • 1.1. Issues
  • 1.2. Backport Commits
  • 1.3. Authors
• 2. Version
• 3. Changelog
• 4. Git Tag
• 5. Package Builds
  • 5.1. RPM Packages
  • 5.2. DEB Packages
• 6. Build Server
• 7. Release Tests
• 8. GitHub Release
• 9. Chocolatey
• 10. Post Release
  • 10.1. Online Documentation
  • 10.2. Announcement
  • 10.3. Project Management

Preparations

Specify the release version.

VERSION=2.10.0

Add your signing key to your Git configuration file, if not already there.

vim $HOME/.gitconfig

[user]
        email = michael.friedrich@icinga.com
        name = Michael Friedrich
        signingkey = D14A1F16

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

Update the version:

sed -i "s/Version: .*/Version: $VERSION/g" VERSION

Changelog

Update the CHANGELOG.md file.

Requirements

Export these environment variables:

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

Generation

Close the version on GitHub.

Run the script which updates the CHANGELOG.md file.

./changelog.py
git diff

Git Tag

Major Releases: Commit these changes to the master branch.

Minor Releases: Commit changes to the support branch.

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

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

git tag -s -m "Version $VERSION" v$VERSION

Push the tag:

git push --tags

For major releases: Create a new support branch:

git checkout master
git push

git checkout -b support/2.11
git push -u origin support/2.11

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.10
git checkout master
git cherry-pick support/2.10
git merge --strategy=ours support/2.10
git push origin master

Package Builds

RPM Packages

git clone git@github.com:icinga/rpm-icinga2.git && cd rpm-icinga2

Branch Workflow

Major releases are branched off master.

git checkout master && git pull

Bugfix releases are created in the release branch and later merged to master.

git checkout release && git pull

Release Commit

Set the Version, Revision and changelog inside the spec file.

sed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec

vim icinga2.spec

%changelog
* Tue Jul 17 2018 Michael Friedrich <michael.friedrich@icinga.com> 2.9.0-1
- Update to 2.9.0

git commit -av -m "Release 2.9.0-1"
git push

Note for major releases: Update release branch to latest.

git checkout release && git pull && git merge master && git push

Note for minor releases: Cherry-pick the release commit into master.

git checkout master && git pull && git cherry-pick release && git push

DEB Packages

git clone git@github.com:icinga/deb-icinga2.git && cd deb-icinga2

Branch Workflow

Major releases are branched off master.

git checkout master && git pull

Bugfix releases are created in the release branch and later merged to master.

git checkout release && git pull

Release Commit

Set the Version, Revision and changelog inside the spec file.

./dch 2.9.0-1 "Update to 2.9.0"

git commit -av -m "Release 2.9.0-1"
git push

git commit -av -m "Release 2.9.0-1"

Note for major releases: Update release branch to latest.

git checkout release && git pull && git merge master && git push

Note for minor releases: Cherry-pick the release commit into master.

git checkout master && git pull && git cherry-pick release && git push

DEB with dch on macOS

docker run -v `pwd`:/mnt/packaging -ti ubuntu:xenial bash

apt-get update && apt-get install git ubuntu-dev-tools vim -y
cd /mnt/packaging

git config --global user.name "Michael Friedrich"
git config --global user.email "michael.friedrich@icinga.com"

./dch 2.10.0-1 "Update to 2.10.0"

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.
  • Wait until all jobs have passed and then publish them one by one with allow_release
• Build the newly created Git tag for Windows: refs/tags/v2.10.0 as source and v2.10.0 as package name.

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.

CentOS

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

Debian

docker run -ti debian:stretch bash

apt-get update && apt-get install -y wget curl gnupg apt-transport-https

DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
 echo "deb http://packages.icinga.com/debian icinga-${DIST} main" > \
 /etc/apt/sources.list.d/${DIST}-icinga.list
 echo "deb-src http://packages.icinga.com/debian icinga-${DIST} main" >> \
 /etc/apt/sources.list.d/${DIST}-icinga.list

curl https://packages.icinga.com/icinga.key | apt-key add -
apt-get -y install icinga2
icinga2 daemon

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 (or use the one generated on https://packages.icinga.com/windows):

cpack

Fetch the API key from https://chocolatey.org/account and use the choco push command line.

choco apikey --key xxx --source https://push.chocolatey.org/

choco push Icinga2-v2.10.0.nupkg --source https://push.chocolatey.org/

Post Release

Online Documentation

Navigate to puppet-customer/icinga.git and do the following steps:

Testing

git checkout testing && git pull
vim files/var/www/docs/config/icinga2-latest.yml

git commit -av -m "icinga-web1: Update docs for Icinga 2"

git push

SSH into icinga-web1 and do a manual Puppet dry run with the testing environment.

puppet agent -t --environment testing --noop

Once succeeded, continue with production deployment.

Production

git checkout master && git pull
git merge testing
git push

SSH into icinga-web1 and do a manual Puppet run from the production environment (default).

puppet agent -t

Announcement

• Create a new blog post on icinga.com/blog
• Social media: Twitter, Facebook, Xing, LinkedIn
• Update IRC channel topic

Project Management

• Add new minor version on GitHub.