-# Release Workflow
-
-Print this document.
+# Release Workflow <a id="release-workflow"></a>
+
+#### Table of Content
+
+- [1. Preparations](#preparations)
+ - [1.1. Issues](#issues)
+ - [1.2. Backport Commits](#backport-commits)
+ - [1.3. Authors](#authors)
+- [2. Version](#version)
+- [3. Changelog](#changelog)
+- [4. Git Tag](#git-tag)
+- [5. Package Builds](#package-builds)
+ - [5.1. RPM Packages](#rpm-packages)
+ - [5.2. DEB Packages](#deb-packages)
+- [6. Build Server](#build-server)
+- [7. Release Tests](#release-tests)
+- [8. GitHub Release](#github-release)
+- [9. Chocolatey](#chocolatey)
+- [10. Post Release](#post-release)
+ - [10.1. Online Documentation](#online-documentation)
+ - [10.2. Announcement](#announcement)
+ - [10.3. Project Management](#project-management)
+
+## Preparations <a id="preparations"></a>
Specify the release version.
- VERSION=2.6.1
+```
+VERSION=2.9.2
+```
+
+Add your signing key to your Git configuration file, if not already there.
+
+```
+vim $HOME/.gitconfig
-## Issues
+[user]
+ email = michael.friedrich@icinga.com
+ name = Michael Friedrich
+ signingkey = D14A1F16
+```
+
+### Issues <a id="issues"></a>
Check issues at https://github.com/Icinga/icinga2
-## Backport Commits
+### Backport Commits <a id="backport-commits"></a>
- $ git checkout master
- $ ./pick.py -V $VERSION
+For minor versions you need to manually backports any and all commits from the
+master branch which should be part of this release.
-The script creates a new branch 'auto-merged-<VERSION>' 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.
+### Authors <a id="authors"></a>
-If there are any merge commits you will need to manually fix them and continue the
-rebase until no commits are left:
+Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
- $ git rebase --continue
+```
+git checkout master
+git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
-After finishing the rebase the branch needs to be merged into the support branch:
+## Version <a id="version"></a>
- $ git checkout support/2.6
- $ git merge --ff-only auto-merged-2.6.1
+Update the version:
-## Authors
+```
+sed -i "s/Version: .*/Version: $VERSION/g" VERSION
+sed -i "s/VERSION=.*/VERSION=$VERSION/g" RELEASE.md
+```
-Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
+## Changelog <a id="changelog"></a>
+
+Update the [CHANGELOG.md](CHANGELOG.md) file.
- $ git checkout master
- $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
+Export these environment variables:
-## Version
+```
+export ICINGA_GITHUB_AUTH_USERNAME='user'
+export ICINGA_GITHUB_AUTH_TOKEN='token'
+export ICINGA_GITHUB_PROJECT='icinga/icinga2'
+```
-Update the version number in the following file:
+Run the script which updates the [CHANGELOG.md](CHANGELOG.md) file.
-* [icinga2.spec]: Version: (.*)
+```
+./changelog.py
+git diff
+```
-Example:
+## Git Tag <a id="git-tag"></a>
- gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
+> **Major Releases**: Commit these changes to the `master` branch.
+>
+> **Minor Releases**: Commit changes to the `support` branch.
-## Changelog
+```
+git commit -v -a -m "Release version $VERSION"
+```
-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.
-You need to copy and paste the output manually.
+Create a signed tag (tags/v<VERSION>) on the `master` branch (for major
+releases) or the `support` branch (for minor releases).
-Changelog:
+```
+git tag -s -m "Version $VERSION" v$VERSION
+```
- $ ./changelog.py -V $VERSION
+Push the tag:
-Docs:
+```
+git push --tags
+```
- $ ./changelog.py -V $VERSION -l
+**For major releases:** Create a new `support` branch:
-Wordpress:
+```
+git checkout master
+git checkout -b support/2.9
+git push -u origin support/2.9
+```
- $ ./changelog.py -V $VERSION -H -l
+**For minor releases:** Push the support branch, cherry-pick the release commit
+into master and merge the support branch:
-## Git Tag
+```
+git push -u origin support/2.8
+git checkout master
+git cherry-pick support/2.8
+git merge --strategy=ours support/2.8
+git push origin master
+```
-Commit these changes to the "master" branch:
+## Package Builds <a id="package-builds"></a>
- $ git commit -v -a -m "Release version $VERSION"
+### RPM Packages <a id="rpm-packages"></a>
-For minor releases: Cherry-pick this commit into the "support" branch.
+```
+git clone git@github.com:icinga/rpm-icinga2.git && cd rpm-icinga2
+```
-Create a signed tag (tags/v<VERSION>) on the "master" branch (for major
-releases) or the "support" branch (for minor releases).
+#### Branch Workflow
-GB:
+**Major releases** are branched off `master`.
- $ git tag -u EE8E0720 -m "Version $VERSION" v$VERSION
+```
+git checkout master && git pull
+```
-MF:
+**Bugfix releases** are created in the `release` branch and later merged to master.
- $ git tag -u D14A1F16 -m "Version $VERSION" v$VERSION
+```
+git checkout release && git pull
+```
-Push the tag.
+#### Release Commit
- $ git push --tags
+Set the `Version`, `Revision` and `changelog` inside the spec file.
-For major releases: Create a new "support" branch:
+```
+sed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
- $ git checkout master
- $ git checkout -b support/2.6
- $ git push -u origin support/2.6
+vim icinga2.spec
-For minor releases: Push the support branch, cherry-pick the release commit
-into master and merge the support branch:
+%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 <a id="deb-packages"></a>
+
+```
+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
+```
- $ git push -u origin support/2.6
- $ git checkout master
- $ git cherry-pick support/2.6
- $ git merge --strategy=ours support/2.6
- $ git push origin master
+**Bugfix releases** are created in the `release` branch and later merged to master.
-# External Dependencies
+```
+git checkout release && git pull
+```
-## Build Server
+#### 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
+cd /mnt/packaging
+
+git config --global user.name "Michael Friedrich"
+git config --global user.email "michael.friedrich@icinga.com"
+
+./dch 2.9.0-1 "Update to 2.9.0"
+```
+
+
+## Build Server <a id="build-server"></a>
* 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
+## Release Tests <a id="release-tests"></a>
* Test DB IDO with MySQL and PostgreSQL.
* Provision the vagrant boxes and test the release packages.
-* Test the [setup wizard](http://packages.icinga.com/windows/) inside a Windows VM.
-
+* Test the [setup wizard](https://packages.icinga.com/windows/) inside a Windows VM.
* Start a new docker container and install/run icinga2.
Example for CentOS7:
- $ docker run -ti centos:latest bash
+```
+docker run -ti centos:latest bash
- # yum -y install http://packages.icinga.com/epel/7/release/noarch/icinga-rpm-release-7-1.el7.centos.noarch.rpm
- # yum -y install icinga2
- # icinga2 daemon -C
+yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
+yum -y install icinga2
+icinga2 daemon -C
+```
- # systemctl start icinga2
- # tail -f /var/log/icinga2/icinga2.log
+## GitHub Release <a id="github-release"></a>
-## GitHub Release
+Create a new release for the newly created Git tag: https://github.com/Icinga/icinga2/releases
-Create a new release for the newly created Git tag.
-https://github.com/Icinga/icinga2/releases
-
-## Chocolatey
+## Chocolatey <a id="chocolatey"></a>
Navigate to the git repository on your Windows box which
already has chocolatey installed. Pull/checkout the release.
Create the nupkg package:
- cpack
+```
+cpack
+```
Install the created icinga2 package locally:
- choco install icinga2 -version 2.6.1 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
+```
+choco install icinga2 -version 2.9.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
+```
Upload the package to [chocolatey](https://chocolatey.org/packages/upload).
-## Online Documentation
+## Post Release <a id="post-release"></a>
+
+### Online Documentation <a id="online-documentation"></a>
-SSH into the web box, navigate into `icinga2-latest/module/icinga2`
-and pull the current support branch.
+Ask @bobapple to update the documentation at docs.icinga.com.
-## Announcement
+### Announcement <a id="announcement"></a>
* Create a new blog post on www.icinga.com/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)
+* 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
+### Project Management <a id="project-management"></a>
-* Add new minor version
-* Close the released 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