]> granicus.if.org Git - icinga2/blobdiff - RELEASE.md
Merge pull request #7404 from Icinga/bugfix/livestatus-interval
[icinga2] / RELEASE.md
index d446c7007243c65f5e0e838ffb7ea433d06838bc..cbaed15bd2f1244d584fc3f66b8b6000dda84a47 100644 (file)
@@ -26,7 +26,7 @@
 Specify the release version.
 
 ```
-VERSION=2.9.0
+VERSION=2.11.0-rc1
 ```
 
 Add your signing key to your Git configuration file, if not already there.
@@ -60,7 +60,7 @@ git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
 
 ## Version <a id="version"></a>
 
-Update the version in the version file:
+Update the version:
 
 ```
 sed -i "s/Version: .*/Version: $VERSION/g" VERSION
@@ -68,22 +68,10 @@ sed -i "s/Version: .*/Version: $VERSION/g" VERSION
 
 ## Changelog <a id="changelog"></a>
 
-Update the [CHANGELOG.md](CHANGELOG.md) file.
+Link to the milestone and closed=1 as filter.
 
-Export these environment variables:
-
-```
-export ICINGA_GITHUB_AUTH_USERNAME='user'
-export ICINGA_GITHUB_AUTH_TOKEN='token'
-export ICINGA_GITHUB_PROJECT='icinga/icinga2'
-```
-
-Run the script which updates the [CHANGELOG.md](CHANGELOG.md) file.
-
-```
-./changelog.py
-git diff
-```
+Manually update the best of collected from the
+milestone description.
 
 ## Git Tag  <a id="git-tag"></a>
 
@@ -112,18 +100,20 @@ git push --tags
 
 ```
 git checkout master
-git checkout -b support/2.9
-git push -u origin support/2.9
+git push
+
+git checkout -b support/2.12
+git push -u origin support/2.12
 ```
 
 **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.8
+git push -u origin support/2.11
 git checkout master
-git cherry-pick support/2.8
-git merge --strategy=ours support/2.8
+git cherry-pick support/2.11
+git merge --strategy=ours support/2.11
 git push origin master
 ```
 
@@ -154,25 +144,33 @@ git checkout release && git pull
 Set the `Version`, `Revision` and `changelog` inside the spec file.
 
 ```
+VERSION=2.11.0-rc1
+
 sed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
 
 vim icinga2.spec
 
 %changelog
-* Tue Jul 17 2018 Michael Friedrich <michael.friedrich@icinga.com> 2.9.0-1
-- Update to 2.9.0
+* Tue Mar 19 2019 Michael Friedrich <michael.friedrich@icinga.com> 2.10.4-1
+- Update to 2.10.4
 ```
 
 ```
-git commit -av -m "Release 2.9.0-1"
+git commit -av -m "Release $VERSION-1"
 git push
 ```
 
 **Note for major releases**: Update release branch to latest.
-`git checkout release && git pull && git merge master && git push`
+
+```
+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`
+
+```
+git checkout master && git pull && git cherry-pick release && git push
+```
 
 
 ### DEB Packages  <a id="deb-packages"></a>
@@ -197,41 +195,46 @@ git checkout release && git pull
 
 #### Release Commit
 
-Set the `Version`, `Revision` and `changelog` inside the spec file.
+Set the `Version`, `Revision` and `changelog` by using the `dch` helper.
 
 ```
-./dch 2.9.0-1 "Update to 2.9.0"
+VERSION=2.10.4
+
+./dch $VERSION-1 "Update to $VERSION"
 ```
 
 ```
-git commit -av -m "Release 2.9.0-1"
+git commit -av -m "Release $VERSION-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`
+
+```
+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`
 
+```
+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
+docker run -v `pwd`:/mnt/packaging -ti ubuntu:bionic bash
 
-apt-get update
-apt-get install git ubuntu-dev-tools vim
+apt-get update && apt-get install git ubuntu-dev-tools vim -y
 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"
+VERSION=2.11.0-rc1
+
+./dch $VERSION-1 "Update to $VERSION"
 ```
 
 
@@ -240,7 +243,8 @@ git config --global user.email "michael.friedrich@icinga.com"
 * 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.
+  * Wait until all jobs have passed and then publish them one by one with `allow_release`
+* Build the newly created Git tag for Windows: `refs/tags/v2.10.0` as source and `v2.10.0` as package name.
 
 ## Release Tests  <a id="release-tests"></a>
 
@@ -249,7 +253,7 @@ git config --global user.email "michael.friedrich@icinga.com"
 * 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:
+### CentOS
 
 ```
 docker run -ti centos:latest bash
@@ -259,42 +263,111 @@ yum -y install icinga2
 icinga2 daemon -C
 ```
 
+### Debian
+
+```
+docker run -ti debian:stretch bash
+
+apt-get update && apt-get install -y wget curl gnupg apt-transport-https
+
+DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
+ echo "deb https://packages.icinga.com/debian icinga-${DIST} main" > \
+ /etc/apt/sources.list.d/${DIST}-icinga.list
+ echo "deb-src https://packages.icinga.com/debian icinga-${DIST} main" >> \
+ /etc/apt/sources.list.d/${DIST}-icinga.list
+
+curl https://packages.icinga.com/icinga.key | apt-key add -
+apt-get -y install icinga2
+icinga2 daemon
+```
+
 ## GitHub Release  <a id="github-release"></a>
 
 Create a new release for the newly created Git tag: https://github.com/Icinga/icinga2/releases
 
+> Hint: Choose [tags](https://github.com/Icinga/icinga2/tags), pick one to edit and
+> make this a release. You can also create a draft release.
+
+The release body should contain a short changelog, with links
+into the roadmap, changelog and blogpost.
+
+
 ## 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:
+Create the nupkg package (or use the one generated on https://packages.icinga.com/windows):
 
 ```
 cpack
 ```
 
-Install the created icinga2 package locally:
+Fetch the API key from https://chocolatey.org/account and use the `choco push`
+command line.
 
 ```
-choco install icinga2 -version 2.9.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
+choco apikey --key xxx --source https://push.chocolatey.org/
+
+choco push Icinga2-v2.11.0.nupkg --source https://push.chocolatey.org/
 ```
 
-Upload the package to [chocolatey](https://chocolatey.org/packages/upload).
 
 ## Post Release  <a id="post-release"></a>
 
 ### Online Documentation  <a id="online-documentation"></a>
 
-Ask @bobapple to update the documentation at docs.icinga.com.
+> Only required for major releases.
+
+Navigate to `puppet-customer/icinga.git` and do the following steps:
+
+#### Testing
+
+```
+git checkout testing && git pull
+vim files/var/www/docs/config/icinga2-latest.yml
+
+git commit -av -m "icinga-web: Update docs for Icinga 2"
+
+git push
+```
+
+SSH into the webserver and do a manual Puppet dry run with the testing environment.
+
+```
+puppet agent -t --environment testing --noop
+```
+
+Once succeeded, continue with production deployment.
+
+#### Production
+
+```
+git checkout master && git pull
+git merge testing
+git push
+```
+
+SSH into the webserver and do a manual Puppet run from the production environment (default).
+
+```
+puppet agent -t
+```
+
+#### Manual Generation
+
+SSH into the webserver or ask @bobapple.
+
+```
+cd /usr/local/icinga-docs-tools && ./build-docs.rb -c /var/www/docs/config/icinga2-latest.yml
+```
 
 ### Announcement  <a id="announcement"></a>
 
-* 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
+* Create a new blog post on [icinga.com/blog](https://icinga.com/blog) including a featured image
+* Create a release topic on [community.icinga.com](https://community.icinga.com)
+* Release email to net-tech & team
 
 ### Project Management  <a id="project-management"></a>
 
 * Add new minor version on [GitHub](https://github.com/Icinga/icinga2/milestones).
-* Close the released version on [GitHub](https://github.com/Icinga/icinga2/milestones).