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

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