Foreman 1.22.0 release process

Development Releases
1

Writing release notes

  • Update manual if applicable for any additional installation steps
  • Draft release notes in markdown (example), with these sections (and do not use personal pronouns):
    • Headline features: half a dozen important features with a few sentences description each
    • Upgrade notes: all important notices that users must be aware of before upgrading
    • 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. You can auto-generate changes using the ‘changelog’ command in tool_belt
    • CLI release notes are taken from the hammer-cli and hammer-cli-foreman changelogs
    • Link to installer changelogs and note versions being used
  • Get the apipie doc and place it in api/1.22

Preparing code

  • Request Hammer CLI releases from maintainers if desired
  • Make patch releases of installer modules that have important changes
    • Branch to MAJ.MIN-stable if recent changes to the module aren’t suitable for patch (x.y.z) release
  • Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
  • Add a new Redmine version for the next minor, unless the series is EOL. Be sure the version is set to sharing with subprojects.
  • Remove/change release field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
  • Change Redmine version 1.22.0 state to Closed
  • List all issues targeted at the release, order by Closed date ascending and use git cherry-pick -x to cherry pick from develop to 1.22.0-stable branch
  • Clone tool_belt and run:
    • ./tools.rb setup-environment configs/foreman/1.22.yaml
    • ./tools.rb cherry-picks --version 1.22.0 configs/foreman/1.22.yaml
    • Verify tickets in the cherry_picks_1.22.0 file are accounted for or additional cherry pick them

Tagging a release

  • In foreman 1.22-stable:
    • Make sure test_1_22_stable is green
    • run make -C locale tx-update (if Transifex has not switched to the next major release yet, usually after .2)
    • run script/sync_templates.sh
    • update template snapshots with rake snapshots:generate RAILS_ENV=test and verify changes are expected
    • change VERSION to 1.22.0
    • Run extras/changelog
    • Commit: git commit -am "Release 1.22.0"
    • Tag: git tag -s -m "Release 1.22.0" 1.22.0
    • Push: git push --follow-tags
  • In smart-proxy 1.22-stable:
    • Make sure test_proxy_1_22_stable is green
    • change VERSION to 1.22.0
    • Run extra/changelog
    • Commit: git commit -am "Release 1.22.0"
    • Tag: git tag -s -m "Release 1.22.0" 1.22.0
    • Push: git push --follow-tags
  • In foreman-selinux 1.22-stable:
    • change VERSION to 1.22.0
    • Run extras/changelog
    • Commit: git commit -am "Release 1.22.0"
    • Tag: git tag -s -m "Release 1.22.0" 1.22.0
    • Push: git push --follow-tags
  • In foreman-installer 1.22-stable:
    • change VERSION to 1.22.0
    • Commit: git commit -am "Release 1.22.0"
    • Tag: git tag -s -m "Release 1.22.0" 1.22.0
    • Push: git push --follow-tags
  • Run the Jenkins Tarballs Release to create tarballs
  • Download, inspect, sign and upload detached signatures

Note: If for some reason there was an issue with the tarballs that required uploading new tarballs, CDN cache should be invalidated so that the builders use the updated tarballs.

Packaging a release

Background documentation

2

I’ve triggered release_test but it’ll fail and I’ll be out tomorrow. @tbrisker to manually test:

git clone https://github.com/theforeman/forklift
cd forklift
./bin/box-downloader 'https://ci.theforeman.org/job/release_test/7/label=el&&ipv6,os=centos7/'
# This will output something like:
# Downloading 80-tmp-systest-foreman-centos7-7.yaml to vagrant/boxes.d/80-tmp-systest-foreman-centos7-7.yaml
# Found boxes: systest-foreman-centos7-7
vagrant up systest-foreman-centos7-7

The same can be done with debian9, ubuntu1604 and ubuntu1804. Also note you probably should vagrant destroy boxes after unless you have a lot of memory.

1 Like