Foreman 2.4.0-rc2 release process

Make this post a wiki

Manual updates: 2021-02-16

  • 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 doc and place it in the api/2.4 directory

Preparing code: 2021-02-16

  • 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
  • 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 2.4.0-rc2 in redmine. issues.rb can be used to generate a comparison between the two.

Tagging a release: 2021-02-16

  • In foreman 2.4-stable:
    • Make sure test_2_4_stable is green
    • run make -C locale tx-update [no changes]
    • Tag the release using 2.4.0-rc2 && git push upstream 2.4-stable --follow-tags
  • In smart-proxy 2.4-stable:
  • In foreman-selinux 2.4-stable:
    • Tag the release using 2.4.0-rc2 && git push upstream 2.4-stable --follow-tags
  • In foreman-installer 2.4-stable:
    • Tag the release using 2.4.0-rc2 && git push upstream 2.4-stable --follow-tags
  • Run the Jenkins Tarballs Release to create tarballs
  • Update release version similar to here
  • Sign Tarballs

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-02-16

Background documentation

After the packages have been released

  • Announce the release on Discourse

  • Update the topic in #theforeman channel on Freenode

  • Share the release announcement on twitter

  • Release pipeline will trigger plugins test pipeline, which doesn’t block releases but can be used to understand known issues around plugin compatibility with Foreman 2.4.