Project

General

Profile

Actions
History

Development Resources »

Release Process » History » Revision 101

« Previous | Revision 101/211 (diff) | Next »
Dominic Cleal, 08/13/2014 05:26 AM
WIP, updating release tagging process

Release Process

For each major release (i.e. not patch releases), the project selects a "release nanny" who's responsible for taking the develop branch through to release.

Please amend these lists as you see free, and as you find what works and what doesn't work.

First steps

  1. Select the release nanny
  2. Ensure RPM and Debian nightly packages are in good shape and all RPM dependencies are up to date
  3. Ensure Transifex project is up to date
  4. Decide on the version number
  5. If number has changed, update version number in redmine
  6. Add next+1 anticipated version number to redmine under Releases, sharing "With subprojects"
  7. Check roadmap and issue search (example)
    • reassign major features to next+1 version or remove version
    • assign relevant bugs to this upcoming release
    • multiple bugs can be managed using checkboxes and then right clicking on the boxes for a menu
    • create public custom query with target version set, sorted by status ascending, then priority descending
  8. Go through targeted features in redmine and align features with our backlog

Before creating branch in git

  1. Announce beginning of bug-squashing to foreman-dev (example)
  2. Copy website manual content (theforeman.org repo) from previous version to this version (example)
  3. Update manual if applicable for any additional installation steps
  4. Draft release notes in markdown (example) using roadmap, with these sections (and do not use personal pronouns):
    1. Headline features: half a dozen important features with a few sentences description each
    2. Upgrade notes: all important notices that users must be aware of before upgrading
    3. Release notes: bullet point list by category of most changes, excluding bug fixes for issues introduced during the release cycle, include link to bug numbers (helper vim search and replace command bellow)
  5. Check git log for any changes without associated bug number and add to release notes if applicable (https://gist.github.com/lzap/6520535)
  6. Refresh kickstart, snippet and partition table templates from the community-templates repo to Foreman core
  7. Request creation of tags and build targets in Koji from rel-eng:
  8. Add new plugin tags (i.e. 1.3) to Koji plugins mash script (foreman-mash-split-plugins.py)
  9. Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit
  10. Add new lookaside repos to foreman-packaging/rpm/develop, repoclosure/yum_*.conf

Helper vim command to replace all (#1234) bugs with links:

%s/(\(#\)\([0-9]\+\))/(\[\1\2]\(http:\/\/projects.theforeman.org\/issues\/\2))/g

Pre-release candidates

When ready to branch for release candidates.

  1. Add new languages that are at a reasonable completion on Transifex to develop
  2. In foreman develop run make -C locale tx-update
  3. In foreman, smart-proxy, foreman-installer and foreman-selinux branch develop to 1.2-stable (from this point cherry-picks into this branch only from this point using: git cherry-pick -x SHA)
  4. In foreman-installer, branch 1.2-stable,
    1. change Puppetfile from git references to specific version ranges (e.g. >= 1.3.1 < 1.4.0)
  5. In foreman develop commit with message "Bump version to 1.3-develop":
    1. change to VERSION to 1.3.0-develop
    2. run extras/changelog
  6. In smart-proxy develop commit with message "Bump version to 1.3-develop":
    1. change to VERSION to 1.3.0-develop
    2. run extra/changelog
  7. In foreman-selinux develop commit with message "Bump version to 1.3-develop":
    1. change to VERSION to 1.3.0-develop
    2. run extras/changelog
  8. In foreman-installer develop commit with message "Bump version to 1.3-develop":
    1. change to VERSION to 1.3.0-develop
  9. In foreman-packaging, branch rpm/develop to rpm/1.2-stable
  10. In foreman-packaging/rpm/develop, change foreman/foreman-proxy/foreman-installer/foreman-selinux version to 1.3.0, add %changelog entry
  11. In foreman-packaging/deb/develop, change foreman/foreman-proxy/foreman-installer version to 1.3.0 via a changelog entry
  12. Update foreman-dev with translations status to encourage 100% translations before release, announce string freeze date
  13. Change Transifex resource URL to point to the 1.2-stable branch
  14. Set up test_1_2_stable job on Jenkins, copy from existing stable or test_develop (don't use dots in the name, it breaks)
  15. Update release notes in new website manual version

For each release candidate

  1. Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
  2. Check for non-SCL packages that might be in the SCL tag and untag them, else these will cause mash precedence issues
  3. In foreman 1.2-stable run make -C locale tx-update
  4. In foreman 1.2-stable commit with message "Release 1.2.0-RC1":
    1. change VERSION to 1.2.0-RC1
    2. run extras/changelog
  5. In smart-proxy 1.2-stable commit with message "Release 1.2.0-RC1":
    1. change VERSION to 1.2.0-RC1
    2. run extra/changelog
  6. In foreman-selinux 1.2-stable commit with message "Release 1.2.0-RC1":
    1. change VERSION to 1.2.0-RC1
    2. run extras/changelog
  7. In foreman-installer 1.2-stable commit with message "Release 1.2.0-RC1":
    1. change VERSION to 1.2.0-RC1
  8. Tag commits in foreman, smart-proxy, foreman-installer and foreman-selinux: git tag -m "Release 1.2.0-RC1" 1.2.0-RC1
  9. Push to the project repos: git push project && git push project 1.2.0-RC1
  10. In foreman-packaging rpm/1.2 branch:
    1. change foreman.spec, foreman-proxy.spec version to "1.2.0", release to "0.1.RC1", add %changelog entry
    2. change foreman-selinux.spec version to "1.2.0", release to "0.1", uncomment alphatag* (replace # with %) and change to RC1, add %changelog entry
    3. change foreman/foreman.repo URLs from /nightly to /rc, change "nightly" in name to "RC" and enable gpg checking
    4. change foreman/foreman-plugins.repo URLs from /plugins/nightly to /plugins/1.2, change "nightly" in name to "1.2" and DO NOT enable GPG checking
    5. Perform RPM scratch build of foreman, foreman-installer, foreman-proxy and foreman-selinux (see RPM_Packaging)
  11. RPM_Packaging: follow release procedure for foreman, foreman-proxy, foreman-installer and foreman-selinux using Jenkins
  12. Debian_Packaging: Update build.sh and changelog files with appropriate data
  13. Build foreman-installer Debian package from 1.2-stable (see Debian_Packaging)
  14. Update theforeman.org sections:
    1. _includes/social.html version number
    2. _includes/header.html manual links
  15. Generate and sign tarball of foreman and smart-proxy:
    1. git archive --prefix=foreman-1.2.0-RC1/ 1.2.0-RC1 | bzip2 -9 > foreman-1.2.0-RC1.tar.bz2
    2. gpg -b -u packages@theforeman.org foreman-1.2.0-RC1.tar.bz2 (requires packages key)
  16. Follow "Publishing releases" below

For final release

  1. Update version and dependency versions in all foreman-installer submodules (TODO: script this)
  2. Update submodules on foreman-installer's develop branch via PR, cherry-pick down to 1.2-stable
  3. Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
  4. In foreman 1.2-stable run make -C locale tx-update
  5. In foreman 1.2-stable commit with message "Release 1.2.0":
    1. change to VERSION to 1.2.0
    2. change foreman.spec version to "1.2.0", release to "1", add %changelog entry
    3. run extras/changelog
    4. change extras/packaging/rpm/sources/foreman.repo URL from /rc to /releases/1.2, change "RC" in name to "1.4" and make sure gpgcheck is on
  6. In smart-proxy 1.2-stable commit with message "Release 1.2.0":
    1. change to lib/proxy.rb VERSION to 1.2.0
    2. change foreman-proxy.spec version to "1.2.0", release to "1", add %changelog entry
    3. run extra/changelog
  7. In foreman-selinux 1.2-stable commit with message "Release 1.2.0":
    1. change foreman-selinux.spec version to "1.2.0", release to "1", comment alphatag* (replace % with #), add %changelog entry
    2. run extras/changelog
  8. In foreman-installer 1.2-stable commit with message "Release 1.2.0":
    1. change foreman-installer.spec version to "1.2.0", release to "1", comment alphatag* (replace % with #), add %changelog entry
  9. Tag commits in foreman, smart-proxy, foreman-installer and foreman-selinux: git tag -m "Release 1.2.0" 1.2.0
  10. Push to your GitHub repo to enable testing first
  11. Perform RPM scratch build of foreman, foreman-installer, foreman-proxy and foreman-selinux (see RPM_Packaging)
    1. if they fail, revert your branch to current project/1.2-stable branch, fix the issue in your repo and retry until it works
  12. Push to the project repo: git push project && git push project 1.2.0
  13. RPM_Packaging: follow release procedure for foreman, foreman-proxy, foreman-installer and foreman-selinux using Jenkins
  14. Debian_Packaging: Update build.sh and changelog files with appropriate data
  15. Build foreman-installer modules from 1.2-stable (see Installer_Packaging workflow)
  16. Build foreman-installer Debian package from 1.2-stable (see Debian_Packaging)
  17. Update theforeman.org sections:
    1. _includes/social.html version number
    2. _includes/header.html manual links
    3. _layouts/homepage.html quickstart link
    4. _layouts/manual.html latestversion
    5. _config.yml quickstart link
  18. Generate and sign tarball of foreman and smart-proxy:
    1. git archive --prefix=foreman-1.2.0/ 1.2.0 | bzip2 -9 > foreman-1.2.0.tar.bz2
    2. gpg -b -u packages@theforeman.org foreman-1.2.0.tar.bz2 (requires packages key)
  19. Merge develop branches into master (git merge -Xtheirs --no-ff) for: foreman, smart-proxy, foreman-installer, foreman-selinux
  20. Follow "Publishing releases" below

Publishing releases (RCs and final)

  1. First RC: Add the new release to the Jenkins packaging_publish_plugins_rpm job matrix
  2. First RC: symlink releases/1.2 to ../rc inside yum.theforeman.org
  3. Final only: remove releases/1.2 symlink
  4. Sign all RPMs (see RPM_Packaging)
  5. Run or request (from rel-eng) RPM repo mash/compose for Koji release tags
  6. Do a dry run of the RPM push process to check repoclosure etc. (see RPM_Packaging)
  7. Push RPMs to repo on the web host, under /rc or /releases/1.2 etc using Jenkins (see RPM_Packaging)
  8. Push foreman-installer to Freight (see Debian_Packaging)
  9. Upload tarballs and detached signatures to http://projects.theforeman.org/projects/foreman/files
    1. Final only: delete all existing RC files to free up space
  10. Upload all installer module .tar.gz files to Puppet Forge
  11. Final only: update $latest class parameter on web class to point to the new version number (see foreman-infra/puppet/modules/web/manifests/init.pp)
  12. Send announcement e-mail to foreman-announce, CC foreman-users, set reply-to to foreman-users
  13. Link to announcement e-mail on IRC, Google+ and update IRC /topic
  14. Update Wikipedia Foreman entry at: https://en.wikipedia.org/wiki/Foreman_(software)
  15. Add release to "Found in release" list in redmine: http://projects.theforeman.org/custom_fields/4/edit

After final release

  1. Sync translations from Transifex into develop and run rake locale:find
  2. Remove target version from all issues assigned to the current release, unless they will be fixed in a future point release

Updated by Dominic Cleal almost 10 years ago · 101 revisions