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.

Pre-release¶

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 Settings, 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. Announce beginning of bug-squashing to foreman-dev (example)
9. Copy website manual content (theforeman.org repo) from previous version to this version (example)
10. Update manual if applicable for any additional installation steps
11. Draft release notes in markdown (example) using roadmap, with these sections:
    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
12. Check git log for any changes without associated bug number and add to release notes if applicable
13. Refresh kickstart, snippet and partition table templates from the community-templates repo to Foreman core
14. Request creation of tags and build targets in Koji from rel-eng (foreman-1.2-rhel6 etc.) as clones of nightly tags

Pre-release candidates¶

When ready to branch for release candidates.

1. In foreman, smart-proxy and foreman-installer, branch develop to 1.2-stable
   • cherry-picks into this branch only from this point using: git cherry-pick -x SHA
2. In foreman develop commit with message "Bump version to 1.2-develop":
   1. change to VERSION to 1.2-develop
   2. change foreman.spec to 1.2.9999, add %25changelog entry
   3. run extras/changelog
   4. run rake locale:find
3. In smart-proxy develop commit with message "Bump version to 1.2-develop":
   1. change to lib/proxy.rb VERSION to 1.2-develop
   2. change foreman-proxy.spec version to 1.2.9999, add %25changelog entry
   3. run extra/changelog
4. Update foreman-dev with translations status to encourage 100%25 translations before release, announce string freeze date
5. Update $repo in both foreman-installer/foreman and foreman_proxy modules to "rc" (example)
6. 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)
7. Update release notes in new website manual version

For each release candidate¶

1. Update version and dependency versions in all foreman-installer submodules
2. Update submodules on foreman-installer's develop branch
3. In foreman 1.2-stable commit with message "Release 1.2.0-RC1":
   1. change to VERSION to 1.2.0-RC1
   2. change foreman.spec version to "1.2.0", release to "0.1.RC1", add %25changelog entry
   3. run extras/changelog
   4. run rake locale:find if before string freeze
   5. change extras/packaging/rpm/sources/foreman.repo URL to /rc from /releases/latest
4. In smart-proxy 1.2-stable commit with message "Release 1.2.0-RC1":
   1. change to lib/proxy.rb VERSION to 1.2.0-RC1
   2. change foreman-proxy.spec version to "1.2.0", release to "0.1.RC1", add %25changelog entry
   3. run extra/changelog
5. Perform RPM scratch build of foreman and foreman-proxy
6. Tag commits in foreman, smart-proxy and foreman-installer: git tag -m "Release 1.2.0-RC1" 1.2.0-RC1
7. git push && git push --tags
8. RPM_Packaging: clone new repo and follow tag and release procedure for foreman and foreman-proxy
9. Debian_Packaging: Update build.sh and changelog files with appropriate data
10. Build foreman-installer modules from 1.2-stable (see Installer_Packaging workflow)
11. Build foreman-installer RPM and Debian packages from 1.2-stable (see RPM_Packaging and Debian_Packaging)
12. Update theforeman.org sections:
    1. both _includes/manuals/1.2/2_quickstart_guide.md and _includes/manuals/1.2/3.2.1_installation.md
       • supported platforms
       • foreman-release path (rc or releases), package version number
       • Debian platforms and repo name (rc or stable)
    2. _includes/releasesplash.html version number
13. 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)
14. Follow "Publishing releases" below

For final release¶

1. Update version and dependency versions in all foreman-installer submodules
2. Revert $repo in both foreman-installer/foreman and foreman_proxy modules to "stable" (example)
3. Update submodules on foreman-installer's develop branch
4. Merge foreman-installer's develop branch into master
5. Build foreman-installer modules from master (see Installer_Packaging workflow)
6. Build foreman-installer RPM and Debian packages from master (see RPM_Packaging and Debian_Packaging)
7. Follow "Publishing releases" below

Publishing releases (RCs and final)¶

1. Request a compose from rel-eng for the Koji release tags
2. Push RPMs to repo on the web host, under /var/www/vhosts/yum/htdocs/rc or /releases/1.2 etc (see RPM_Packaging)
3. Push foreman-installer to Freight (see Debian_Packaging)
4. Upload tarballs and detached signatures to http://projects.theforeman.org/projects/foreman/files
5. Upload all installer module .tar.gz files to Puppet Forge
6. Update $latest class parameter on web class to point to the new version number (see foreman-infra/puppet/modules/web/manifests/init.pp)
7. Send announcement e-mail to foreman-users, foreman-dev