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

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