]> granicus.if.org Git - icinga2/blobdiff - RELEASE.md
Merge pull request #7404 from Icinga/bugfix/livestatus-interval
[icinga2] / RELEASE.md
index 89c7c9df9b73d767b313149f6ffb332deb756216..cbaed15bd2f1244d584fc3f66b8b6000dda84a47 100644 (file)
@@ -26,7 +26,7 @@
 Specify the release version.
 
 ```
-VERSION=2.10.2
+VERSION=2.11.0-rc1
 ```
 
 Add your signing key to your Git configuration file, if not already there.
@@ -68,28 +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.
 
-### Requirements
-
-Export these environment variables:
-
-```
-export ICINGA_GITHUB_AUTH_USERNAME='user'
-export ICINGA_GITHUB_AUTH_TOKEN='token'
-export ICINGA_GITHUB_PROJECT='icinga/icinga2'
-```
-
-### Generation
-
-**Close the version on [GitHub](https://github.com/Icinga/icinga2/milestones).**
-
-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>
 
@@ -120,18 +102,18 @@ git push --tags
 git checkout master
 git push
 
-git checkout -b support/2.11
-git push -u origin support/2.11
+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.10
+git push -u origin support/2.11
 git checkout master
-git cherry-pick support/2.10
-git merge --strategy=ours support/2.10
+git cherry-pick support/2.11
+git merge --strategy=ours support/2.11
 git push origin master
 ```
 
@@ -162,17 +144,19 @@ 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
 ```
 
@@ -211,20 +195,19 @@ 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.
 
@@ -241,7 +224,7 @@ 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 -y
 cd /mnt/packaging
@@ -249,7 +232,9 @@ cd /mnt/packaging
 git config --global user.name "Michael Friedrich"
 git config --global user.email "michael.friedrich@icinga.com"
 
-./dch 2.10.0-1 "Update to 2.10.0"
+VERSION=2.11.0-rc1
+
+./dch $VERSION-1 "Update to $VERSION"
 ```
 
 
@@ -286,9 +271,9 @@ 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 http://packages.icinga.com/debian icinga-${DIST} main" > \
+ echo "deb https://packages.icinga.com/debian icinga-${DIST} main" > \
  /etc/apt/sources.list.d/${DIST}-icinga.list
- echo "deb-src http://packages.icinga.com/debian icinga-${DIST} main" >> \
+ 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 -
@@ -300,6 +285,13 @@ icinga2 daemon
 
 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
@@ -317,7 +309,7 @@ command line.
 ```
 choco apikey --key xxx --source https://push.chocolatey.org/
 
-choco push Icinga2-v2.10.0.nupkg --source https://push.chocolatey.org/
+choco push Icinga2-v2.11.0.nupkg --source https://push.chocolatey.org/
 ```
 
 
@@ -325,6 +317,8 @@ choco push Icinga2-v2.10.0.nupkg --source https://push.chocolatey.org/
 
 ### Online Documentation  <a id="online-documentation"></a>
 
+> Only required for major releases.
+
 Navigate to `puppet-customer/icinga.git` and do the following steps:
 
 #### Testing
@@ -333,12 +327,12 @@ Navigate to `puppet-customer/icinga.git` and do the following steps:
 git checkout testing && git pull
 vim files/var/www/docs/config/icinga2-latest.yml
 
-git commit -av -m "icinga-web1: Update docs for Icinga 2"
+git commit -av -m "icinga-web: Update docs for Icinga 2"
 
 git push
 ```
 
-SSH into icinga-web1 and do a manual Puppet dry run with the testing environment.
+SSH into the webserver and do a manual Puppet dry run with the testing environment.
 
 ```
 puppet agent -t --environment testing --noop
@@ -354,17 +348,25 @@ git merge testing
 git push
 ```
 
-SSH into icinga-web1 and do a manual Puppet run from the production environment (default).
+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 icinga.com/blog
-* Social media: [Twitter](https://twitter.com/icinga), [Facebook](https://www.facebook.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>