Move new password functions into tlsutility

[icinga2] / RELEASE.md

diff --git a/RELEASE.md b/RELEASE.md
index 8764e40526976d5d3f7dba56435a255c79184006..9cfb6d638c7d42cee4c86d4925553d46fd038dc8 100644 (file)
--- a/RELEASE.md
+++ b/RELEASE.md
@@ -2,7 +2,9 @@
 
 Specify the release version.
 
-    VERSION=2.7.0
+```
+VERSION=2.7.2
+```
 
 ## Issues
 
@@ -17,60 +19,98 @@ master branch which should be part of this release.
 
 Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
 
-    $ git checkout master
-    $ git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
+git checkout master
+git log --use-mailmap | grep '^Author:' | cut -f2- -d' ' | sort | uniq > AUTHORS
+```
 
 ## Version
 
-Update the version number in the following file:
+Update the version in the spec file:
 
-* [icinga2.spec]: Version: (.*)
-
-Example:
-
-    gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
+```
+gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
+```
 
 ## Changelog
 
 Update the [CHANGELOG.md](CHANGELOG.md) file.
 
+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
+```
+
 ## 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:
 
-For minor releases: Cherry-pick this commit into the "support" branch.
+```
+git checkout support/2.7
+git cherry-pick master
+```
 
 Create a signed tag (tags/v<VERSION>) on the "master" branch (for major
 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
+```
+
+NH:
 
-Push the tag.
+```
+git tag -u 630F89D9 -m "Version $VERSION" v$VERSION
+```
 
-    $ git push --tags
+Push the tag:
+
+```
+git push --tags
+```
 
 For major releases: Create a new "support" branch:
 
-    $ git checkout master
-    $ git checkout -b support/2.7
-    $ git push -u origin support/2.7
+```
+git checkout master
+git checkout -b support/2.7
+git push -u origin support/2.7
+```
 
 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.7
-    $ git checkout master
-    $ git cherry-pick support/2.7
-    $ git merge --strategy=ours support/2.7
-    $ git push origin master
+```
+git push -u origin support/2.7
+git checkout master
+git cherry-pick support/2.7
+git merge --strategy=ours support/2.7
+git push origin master
+```
 
 # External Dependencies
 
@@ -91,14 +131,13 @@ into master and merge the support branch:
 
 Example for CentOS7:
 
-    $ docker run -ti centos:latest bash
-
-    # yum -y install https://packages.icinga.com/epel/7/release/noarch/icinga-rpm-release-7-2.el7.centos.noarch.rpm
-    # yum -y install icinga2
-    # icinga2 daemon -C
+```
+docker run -ti centos:latest bash
 
-    # systemctl start icinga2
-    # tail -f /var/log/icinga2/icinga2.log
+yum -y install https://packages.icinga.com/epel/icinga-rpm-release-7-latest.noarch.rpm
+yum -y install icinga2
+icinga2 daemon -C
+```
 
 ## GitHub Release
 
@@ -112,23 +151,25 @@ 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.7.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
+```
+choco install icinga2 -version 2.7.0 -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 support branch.
+Ask @bobapple to update the documentation at docs.icinga.com.
 
 ## Announcement
 
 * 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+](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