Merge pull request #122 from MarcusCaepio/master

[icinga2] / RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
index 1561c8779cfec3046b2a47456e5b63ae7bd08175..1eb4bf12ae163f2229c8ff8bbab693a9a0f375fa 100644 (file)
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -2,55 +2,46 @@
 
 Print this document.
 
-## Issues
+Specify the release version.
 
-Check the following issue filters:
+    VERSION=2.6.3
 
-* [Pending backports](https://dev.icinga.org/projects/i2/issues?query_id=41)
-* [Invalid target version](https://dev.icinga.org/projects/i2/issues?query_id=55)
+## Issues
 
-## Backport Commits
+Check issues at https://github.com/Icinga/icinga2
 
-    $ ./pick.py -V 2.4.6
+## Backport Commits
 
-Verify the created branch and replace it into the current support branch.
+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
 
 ## Version
 
-Update the version number in the following files:
+Update the version number in the following file:
 
 * [icinga2.spec]: Version: (.*)
-* [icinga2.nuspec]: <version>(.*)</version>
-* [tools/chocolateyInstall.ps1]: Icinga2-v(.*).exe
-
-## 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:
 
-    $ ./changelog.py -V 2.4.6
+Example:
 
-Docs:
+    gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
 
-    $ ./changelog.py -V 2.4.6 -l
-
-Wordpress:
+## Changelog
 
-    $ ./changelog.py -V 2.4.6 -H -l
+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.
 
@@ -59,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.
 
@@ -72,23 +63,24 @@ Push the tag.
 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 -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.4
+    $ git push -u origin support/2.6
     $ git checkout master
-    $ git cherry-pick support/2.4
-    $ git merge --strategy=ours support/2.4
+    $ git cherry-pick support/2.6
+    $ git merge --strategy=ours support/2.6
     $ git push origin master
 
 # External Dependencies
 
 ## Build Server
 
-* Update Git tags for the release jobs.
+* 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.
 
@@ -96,7 +88,7 @@ into master and merge the support branch:
 
 * Test DB IDO with MySQL and PostgreSQL.
 * Provision the vagrant boxes and test the release packages.
-* Test the [setup wizard](http://packages.icinga.org/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.
 
@@ -104,7 +96,7 @@ 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 https://packages.icinga.com/epel/7/release/noarch/icinga-rpm-release-7-1.el7.centos.noarch.rpm
     # yum -y install icinga2
     # icinga2 daemon -C
 
@@ -116,6 +108,21 @@ Example for CentOS7:
 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.3 -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`
@@ -123,9 +130,9 @@ and pull the current support branch.
 
 ## Announcement
 
-* Create a new blog post on www.icinga.org/blog
+* 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