# Release Workflow
-Print this document.
+Specify the release version.
+
+```
+VERSION=2.7.2
+```
## Issues
-Check the following issue filters:
+Check issues at https://github.com/Icinga/icinga2
+
+## Backport Commits
-* [Pending backports](https://dev.icinga.org/projects/i2/issues?query_id=41)
-* [Valid target version](https://dev.icinga.org/projects/i2/issues?query_id=55)
+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](.mailmap) and [AUTHORS](AUTHORS) files:
- $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
+git checkout master
+git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
## Version
-Update the version number in the following files:
+Update the version in the spec file:
-* [icinga2.spec]: Version: (.*)
-* [icinga2.nuspec]: <version>(.*)</version>
-* [tools/chocolateyInstall.ps1]: Icinga2-v(.*).exe
+```
+gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
+```
## Changelog
-Update the [ChangeLog](ChangeLog), [doc/1-about.md](doc/1-about.md) files using
-the changelog.py script. Also generate HTML for the wordpress release announcement.
-
-Changelog:
+Update the [CHANGELOG.md](CHANGELOG.md) file.
- $ ./changelog.py --version 2.4.0 --project i2
+Export these environment variables:
-Docs:
+```
+export ICINGA_GITHUB_AUTH_USERNAME='user'
+export ICINGA_GITHUB_AUTH_TOKEN='token'
+export ICINGA_GITHUB_PROJECT='icinga/icinga2'
+```
- $ ./changelog.py --version 2.4.0 --project i2 --links
+Run the script which updates the [CHANGELOG.md](CHANGELOG.md) file.
-Wordpress:
-
- $ ./changelog.py --version 2.4.0 --project i2 --html --links
+```
+./changelog.py
+git diff
+```
## Git Tag
Commit these changes to the "master" branch:
- $ git commit -v -a -m "Release version <VERSION>"
+```
+git commit -v -a -m "Release version $VERSION"
+```
+
+For minor releases: Cherry-pick this commit into the "support" branch:
-For minor releases: Cherry-pick this commit into the "support" branch.
+```
+git checkout support/2.7
+git cherry-pick master
+```
Create a signed tag (tags/v<VERSION>) on the "master" branch (for major
releases) or the "support" branch (for minor releases).
GB:
- $ git tag -u EE8E0720 -m "Version <VERSION>" v<VERSION>
+```
+git tag -u EE8E0720 -m "Version $VERSION" v$VERSION
+```
MF:
- $ git tag -u D14A1F16 -m "Version <VERSION>" v<VERSION>
+```
+git tag -u D14A1F16 -m "Version $VERSION" v$VERSION
+```
+
+NH:
-Push the tag.
+```
+git tag -u 630F89D9 -m "Version $VERSION" v$VERSION
+```
- $ git push --tags
+Push the tag:
+
+```
+git push --tags
+```
For major releases: Create a new "support" branch:
- $ git checkout master
- $ git checkout -b support/2.4
- $ git push -u origin support/2.4
+```
+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.4
- $ git checkout master
- $ git cherry-pick support/2.4
- $ git merge --strategy=ours support/2.4
- $ git push origin master
+```
+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
-* Update Git tags for the release jobs.
-
-### Linux
-
+* 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.
-* Provision the vagrant boxes and test the release packages.
-* Start a new docker container and install/run icinga2
+* Build the newly created Git tag for Windows.
-Example for CentOS7:
+## Release Tests
- $ sudo docker run -ti centos:latest bash
+* Test DB IDO with MySQL and PostgreSQL.
+* Provision the vagrant boxes and test the release packages.
+* Test the [setup wizard](https://packages.icinga.com/windows/) inside a Windows VM.
- # 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
+* Start a new docker container and install/run icinga2.
- # systemctl start icinga2
- # tail -f /var/log/icinga2/icinga2.log
+Example for CentOS7:
-### Windows
+```
+docker run -ti centos:latest bash
-* Build the newly created Git tag for Windows.
-* Test the [setup wizard](http://packages.icinga.org/windows/) inside a Windows VM.
+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](https://chocolatey.org/packages/upload).
+
## Online Documentation
-SSH into the web box, navigate into `icinga2-latest/module/icinga2`
-and pull the current icinga2 revision to update what's new".
+Ask @bobapple to update the documentation at docs.icinga.com.
## Announcement
-* Create a new blog post on www.icinga.org/blog
-* Send announcement mail to icinga-announce@lists.icinga.org
-* Social media: [Twitter](https://twitter.com/icinga), [Facebook](https://www.facebook.com/icinga), [G+](http://plus.google.com/+icinga), [Xing](https://www.xing.com/communities/groups/icinga-da4b-1060043), [LinkedIn](https://www.linkedin.com/groups/Icinga-1921830/about)
+* Create a new blog post on www.icinga.com/blog
+* Social media: [Twitter](https://twitter.com/icinga), [Facebook](https://www.facebook.com/icinga), [G+](https://plus.google.com/+icinga), [Xing](https://www.xing.com/communities/groups/icinga-da4b-1060043), [LinkedIn](https://www.linkedin.com/groups/Icinga-1921830/about)
* Update IRC channel topic
# After the release
-* Add new minor version
-* Update Redmine filters for the next major/minor version
+* Add new minor version on [GitHub](https://github.com/Icinga/icinga2/milestones).
+* Close the released version on [GitHub](https://github.com/Icinga/icinga2/milestones).
projects / icinga2 / blobdiff