]> granicus.if.org Git - icinga2/blobdiff - RELEASE.md
Make sure all Redis tasks are executed on the WQ threads
[icinga2] / RELEASE.md
index 9d1c1cc48ba34fdeef90c8334a3f530f0b9d5a43..63bbd9c89b26e3f8dd1b70da72f0dd5c71d8c755 100644 (file)
@@ -1,22 +1,47 @@
-# Quality Assurance
+# Release Workflow
 
-Review and test the changes and issues for this version.
-https://dev.icinga.org/projects/i2/roadmap
+Print this document.
 
-# Release Workflow
+Specify the release version.
+
+    VERSION=2.6.2
+
+## 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](.mailmap) and [AUTHORS](AUTHORS) files:
 
+    $ git checkout master
     $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
 
-Update the version number in the icinga2.spec file.
+## Version
 
-Update the [ChangeLog](ChangeLog), [doc/1-about.md](doc/1-about.md) files using
-the changelog.py script.
+Update the version number in the following file:
+
+* [icinga2.spec]: Version: (.*)
+
+Example:
+
+    gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
+
+## Changelog
+
+Update the [ChangeLog](ChangeLog), [doc/1-about.md](doc/1-about.md) files. Also generate HTML
+for the wordpress release announcement.
+
+## 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.
 
@@ -25,11 +50,11 @@ 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
 
 Push the tag.
 
@@ -38,28 +63,80 @@ Push the tag.
 For major releases: Create a new "support" branch:
 
     $ git checkout master
-    $ git checkout -b support/2.x
-    $ git push -u origin support/2.x
+    $ git checkout -b support/2.6
+    $ git push -u origin support/2.6
+
+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.6
+    $ git checkout master
+    $ git cherry-pick support/2.6
+    $ git merge --strategy=ours support/2.6
+    $ git push origin master
 
 # External Dependencies
 
 ## Build Server
 
-* Build the newly created git tag for Debian/RHEL/SuSE.
+* 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](http://packages.icinga.com/windows/) inside a Windows VM.
+
+* Start a new docker container and install/run icinga2.
+
+Example for CentOS7:
 
-## Github Release
+    $ docker run -ti centos:latest bash
 
-Create a new release from the newly created git tag.
+    # 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
+
+    # 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.6.2 -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".
+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
+* Create a new blog post on www.icinga.com/blog
 * Send announcement mail to icinga-announce@lists.icinga.org
-* Social media
+* 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)
+* Update IRC channel topic
+
+# After the release
+
+* Add new minor version
+* Close the released version
+* Update Redmine filters for the next major/minor version