Foreman 3.1.0-RC2 release process

Make this post a wiki

Roles

Manual updates: 2021-11-29

Release Engineer

  • Update manual if applicable for any additional installation steps
  • Update release notes section in the manual:
    • Release notes: bullet point list by category of all changes, include link to bug numbers. You can auto-generate changes using the release notes script.
    • CLI release notes are taken from the hammer-cli and hammer-cli-foreman changelogs
    • Link to installer changelogs and note versions being used
    • 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
  • Update installer options section using the get-params script (Note: this step can only be done after packages are released)
    Generate the apipie docs and raise pull request in apidocs repository

Preparing code: 2021-11-29

Release Owner

  • Remove/change target version field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
  • Ensure that code in git matches issues fixed in 3.1.0-rc2 in redmine. issues.rb can be used to generate a comparison between the two.

Tagging a release: 2021-11-29

Release Owner

  • In foreman 3.1-stable:
    • Make sure test_3_1_stable is green
    • run make -C locale tx-update
    • Tag the release using tag.sh tag.sh 3.1.0-rc2 && git push upstream 3.1-stable --follow-tags
  • In smart-proxy 3.1-stable:
  • In foreman-selinux 3.1-stable:
    • Tag the release using tag.sh tag.sh 3.1.0-rc2 && git push upstream 3.1-stable --follow-tags
  • In foreman-installer 3.1-stable:
    • Tag the release using tag.sh tag.sh 3.1.0-rc2 && git push upstream 3.1-stable --follow-tags
  • Run the Jenkins Tarballs Release to create tarballs

Release Engineer

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: 2021-11-29

Release Engineer

Background documentation

After the packages have been released

Release Owner