Foreman 1.20.3 release process


Writing release notes

  • Draft release notes in markdown (example), with these sections (and do not use personal pronouns):
    • 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

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
  • Remove/change release field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
  • Change Redmine version 1.20.3 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.20.3-stable branch
  • Clone tool_belt and run:
    • ./tools.rb setup-environment configs/foreman/1.20.yaml
    • ./tools.rb cherry-picks --version 1.20.3 configs/foreman/1.20.yaml
    • Verify tickets in the cherry_picks_1.20.3 file are accounted for or additional cherry pick them

Tagging a release

  • In foreman 1.20-stable:
    • Make sure test_1_20_stable is green
    • run script/
    • update template snapshots with rake snapshots:generate RAILS_ENV=test and verify changes are expected
    • change VERSION to 1.20.3
    • Run extras/changelog
    • Commit: git commit -am "Release 1.20.3"
    • Tag: git tag -s -m "Release 1.20.3" 1.20.3
    • Push: git push --follow-tags
  • In smart-proxy 1.20-stable:
    • Make sure test_proxy_1_20_stable is green
    • change VERSION to 1.20.3
    • Run extra/changelog
    • Commit: git commit -am "Release 1.20.3"
    • Tag: git tag -s -m "Release 1.20.3" 1.20.3
    • Push: git push --follow-tags
  • In foreman-selinux 1.20-stable:
    • change VERSION to 1.20.3
    • Run extras/changelog
    • Commit: git commit -am "Release 1.20.3"
    • Tag: git tag -s -m "Release 1.20.3" 1.20.3
    • Push: git push --follow-tags
  • In foreman-installer 1.20-stable:
    • change VERSION to 1.20.3
    • Commit: git commit -am "Release 1.20.3"
    • Tag: git tag -s -m "Release 1.20.3" 1.20.3
    • 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


The debian release job failed:

17:54:00 Gem::InstallError: spring requires Ruby version >= 2.4.0.
17:54:00 An error occurred while installing spring (2.1.0), and Bundler cannot continue.
17:54:00 Make sure that `gem install spring -v '2.1.0'` succeeds before bundling.
17:54:01 debian/rules:9: recipe for target 'build' failed

We should have cherry picked Bug #27068: Spring 2.1.0 requires Ruby 2.4.0+ - Foreman I guess.


Trying to get a new build with the correct spring version here:


I picked it up again today, but had to look at why repoclosure was failing. Submitted a PR to fix it and applied it locally. Running the tests now.


Next breakage: we have to assign taxonomies since 1.21 (previously untested) so we added a workaround for Feature #26092: When only one taxonomy of specific type is defined, api should default to that taxonomy - Foreman that is now biting us because our 1.20 test doesn’t know how to handle taxonomies.


After that fix the tests are all green. @tbrisker ready to release?


yes please :slight_smile: let me know once they hit the repos to announce it


Feel free to monitor these jobs :slight_smile:


hmmm… the rpm job seems to have finished but i’m getting a 404 on - maybe the cdn needs a flush?


Done. This may need to become part of the release process. cc @evgeni


Hmmm, I dislike flushing the CDN “just” because of a release. I think we need to “tune” how we cache the index pages and 404 and that should suffice.