From 16d3ac8f12933e8cba23b81c8ed426563984d1a5 Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Fri, 26 Apr 2019 10:22:05 +0200 Subject: [PATCH] Update release docs and make changelog a static entry --- CHANGELOG.md | 8 ++++++- RELEASE.md | 53 +++++++++++++++++++++---------------------- doc/12-icinga2-api.md | 1 + 3 files changed, 34 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3f5757c1a..b280fee77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,10 @@ -# Icinga 2.x CHANGELOG +# Icinga 2 CHANGELOG + +Please make sure to always read our [Upgrading](https://icinga.com/docs/icinga2/latest/doc/16-upgrading-icinga-2/) +documentation before switching to a new version. + +Released closed milestones can be found [here](https://github.com/Icinga/icinga2/milestones?state=closed). + ## 2.10.4 (2019-03-19) diff --git a/RELEASE.md b/RELEASE.md index aa5f639d6..34ce7281d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -68,28 +68,10 @@ sed -i "s/Version: .*/Version: $VERSION/g" VERSION ## Changelog -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 @@ -289,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 - @@ -303,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 Navigate to the git repository on your Windows box which @@ -328,6 +317,8 @@ choco push Icinga2-v2.10.0.nupkg --source https://push.chocolatey.org/ ### Online Documentation +> Only required for major releases. + Navigate to `puppet-customer/icinga.git` and do the following steps: #### Testing @@ -336,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 @@ -357,17 +348,25 @@ git merge testing git push ``` -SSH into icinga-web2 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 * 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 team +* Release email to net-tech & team ### Project Management diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md index 9fbc7965b..099a2f4f7 100644 --- a/doc/12-icinga2-api.md +++ b/doc/12-icinga2-api.md @@ -2271,6 +2271,7 @@ Name | Language | Description [Logstash input event stream](https://github.com/bobapple/logstash-input-icinga_eventstream) | Ruby | Forward events as Logstash input [Flapjack events](https://github.com/sol1/flapjack-icinga2) | Golang | Dumping events into Redis for Flapjack processing [Stackstorm integration](https://github.com/StackStorm-Exchange/stackstorm-icinga2) | Python | Processing events and fetching status information +[NodeJS consumer](https://community.icinga.com/t/consume-api-event-stream/1010/6) | NodeJS | Example from our community :) ### Actions