4.6 KiB
Release Workflow
Print this document.
Specify the release version.
VERSION=2.5.4
Issues
Check the following issue filters:
Backport Commits
$ git checkout master
$ ./pick.py -V $VERSION
The script creates a new branch 'auto-merged-' which is based on the current support branch. It then merges all commits from the 'master' branch which reference a ticket for the version that was specified.
If there are any merge commits you will need to manually fix them and continue the rebase until no commits are left:
$ git rebase --continue
After finishing the rebase the branch needs to be merged into the support branch:
$ git checkout support/2.5
$ git merge --ff-only auto-merged-2.5.3
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 number in the following files:
- [icinga2.nuspec]: (.*)
Example:
gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
gsed -i "s/<version>.*<\/version>/<version>$VERSION<\/version>/g" icinga2.nuspec
gsed -i "s/Icinga2-v.*-/Icinga2-v$VERSION-/g" tools/chocolateyInstall.ps1
Changelog
Update the ChangeLog, doc/1-about.md files using the changelog.py script. Also generate HTML for the wordpress release announcement.
Changelog:
$ ./changelog.py -V $VERSION
Docs:
$ ./changelog.py -V $VERSION -l
Wordpress:
$ ./changelog.py -V $VERSION -H -l
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.5
$ git push -u origin support/2.5
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.5
$ git checkout master
$ git cherry-pick support/2.5
$ git merge --strategy=ours support/2.5
$ git push origin master
External Dependencies
Build Server
- Update Git tags for the release jobs.
- 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 http://packages.icinga.org/epel/7/release/noarch/icinga-rpm-release-7-1.el7.centos.noarch.rpm
# yum -y install icinga2
# icinga2 daemon -C
# systemctl start icinga2
# tail -f /var/log/icinga2/icinga2.log
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.5.4 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
Upload the package to chocolatey.
Online Documentation
SSH into the web box, navigate into icinga2-latest/module/icinga2
and pull the current support branch.
Announcement
- Create a new blog post on www.icinga.org/blog
- Send announcement mail to icinga-announce@lists.icinga.org
- Social media: Twitter, Facebook, G+, Xing, LinkedIn
- Update IRC channel topic
After the release
- Add new minor version
- Close the released version
- Update Redmine filters for the next major/minor version