granicus.if.org Git - icinga2/blob - RELEASE.md

   1 # Release Workflow
   2
   3 Specify the release version.
   4
   5 ```
   6 VERSION=2.7.0
   7 ```
   8
   9 ## Issues
  10
  11 Check issues at https://github.com/Icinga/icinga2
  12
  13 ## Backport Commits
  14
  15 For minor versions you need to manually backports any and all commits from the
  16 master branch which should be part of this release.
  17
  18 ## Authors
  19
  20 Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files:
  21
  22 ```
  23 git checkout master
  24 git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS
  25 ```
  26
  27 ## Version
  28
  29 Fetch the latest spec file from the [icinga-packaging](https://github.com/icinga/icinga-packaging)
  30 repository and verify that the latest version is set.
  31
  32 ```
  33 wget -O icinga2.spec https://raw.githubusercontent.com/Icinga/icinga-packaging/rpm/snapshot/icinga2/icinga2.spec
  34 gsed -i "s/Version: .*/Version: $VERSION/g" icinga2.spec
  35 ```
  36
  37 ## Changelog
  38
  39 Update the [CHANGELOG.md](CHANGELOG.md) file.
  40
  41 Export these environment variables:
  42
  43 ```
  44 export ICINGA_GITHUB_AUTH_USERNAME='user'
  45 export ICINGA_GITHUB_AUTH_TOKEN='token'
  46 export ICINGA_GITHUB_PROJECT='icinga/icinga2'
  47 ```
  48
  49 Run the script which updates the [CHANGELOG.md](CHANGELOG.md) file.
  50
  51 ```
  52 ./changelog.py
  53 git diff
  54 ```
  55
  56 ## Git Tag
  57
  58 Commit these changes to the "master" branch:
  59
  60 ```
  61 git commit -v -a -m "Release version $VERSION"
  62 ```
  63
  64 For minor releases: Cherry-pick this commit into the "support" branch.
  65
  66 Create a signed tag (tags/v<VERSION>) on the "master" branch (for major
  67 releases) or the "support" branch (for minor releases).
  68
  69 GB:
  70
  71 ```
  72 git tag -u EE8E0720 -m "Version $VERSION" v$VERSION
  73 ```
  74
  75 MF:
  76
  77 ```
  78 git tag -u D14A1F16 -m "Version $VERSION" v$VERSION
  79 ```
  80
  81 Push the tag.
  82
  83 ```
  84 git push --tags
  85 ```
  86
  87 For major releases: Create a new "support" branch:
  88
  89 ```
  90 git checkout master
  91 git checkout -b support/2.7
  92 git push -u origin support/2.7
  93 ```
  94
  95 For minor releases: Push the support branch, cherry-pick the release commit
  96 into master and merge the support branch:
  97
  98 ```
  99 git push -u origin support/2.7
 100 git checkout master
 101 git cherry-pick support/2.7
 102 git merge --strategy=ours support/2.7
 103 git push origin master
 104 ```
 105
 106 # External Dependencies
 107
 108 ## Build Server
 109
 110 * Verify package build changes for this version.
 111 * Test the snapshot packages for all distributions beforehand.
 112 * Build the newly created Git tag for Debian/RHEL/SuSE.
 113 * Build the newly created Git tag for Windows.
 114
 115 ## Release Tests
 116
 117 * Test DB IDO with MySQL and PostgreSQL.
 118 * Provision the vagrant boxes and test the release packages.
 119 * Test the [setup wizard](https://packages.icinga.com/windows/) inside a Windows VM.
 120
 121 * Start a new docker container and install/run icinga2.
 122
 123 Example for CentOS7:
 124
 125     $ docker run -ti centos:latest bash
 126
 127     # yum -y install https://packages.icinga.com/epel/7/release/noarch/icinga-rpm-release-7-2.el7.centos.noarch.rpm
 128     # yum -y install icinga2
 129     # icinga2 daemon -C
 130
 131     # systemctl start icinga2
 132     # tail -f /var/log/icinga2/icinga2.log
 133
 134 ## GitHub Release
 135
 136 Create a new release for the newly created Git tag.
 137 https://github.com/Icinga/icinga2/releases
 138
 139 ## Chocolatey
 140
 141 Navigate to the git repository on your Windows box which
 142 already has chocolatey installed. Pull/checkout the release.
 143
 144 Create the nupkg package:
 145
 146 ```
 147 cpack
 148 ```
 149
 150 Install the created icinga2 package locally:
 151
 152 ```
 153 choco install icinga2 -version 2.7.0 -fdv "%cd%" -source "'%cd%;https://chocolatey.org/api/v2/'"
 154 ```
 155
 156 Upload the package to [chocolatey](https://chocolatey.org/packages/upload).
 157
 158 ## Online Documentation
 159
 160 Edit `config.yml` in the [icinga-docs-tools](https://github.com/Icinga/icinga-docs-tools) repository:
 161
 162 ```
 163 git clone git@github.com:Icinga/icinga-docs-tools.git
 164 cd icinga-docs-tools/
 165 vim config.yml
 166
 167 git commit -av -m "Update to Icinga 2 v$VERSION"
 168 git push
 169 ```
 170
 171 SSH into the web VM and build the docs:
 172
 173 ```
 174 cd /var/www/docs/icinga-docs/latest/
 175 /usr/bin/bundle exec ./build-docs.rb
 176 ```
 177
 178 ## Announcement
 179
 180 * Create a new blog post on www.icinga.com/blog
 181 * 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)
 182 * Update IRC channel topic
 183
 184 # After the release
 185
 186 * Add new minor version on [GitHub](https://github.com/Icinga/icinga2/milestones).
 187 * Close the released version on [GitHub](https://github.com/Icinga/icinga2/milestones).