Foreman 3.11.0 release process

Make this post a wiki (help)


  • Release Owner: @Griffin-Sullivan, @ekohl to fill in after 6/18 since Griffin is out of office.
  • Release Engineer: @
  • Installer Maintainer: @

Preparing code: 2024-06-18

Installer Maintainer

  • 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

Release Owner

  • 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 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.11.0 in redmine. issues can be used to generate a comparison between the two.
  • Change Redmine version 3.11.0 state to Closed using close_redmine_version

Tagging a release: 2024-06-18

Release Owner

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: 2024-06-18

Note it is considered good practice to release on a day when the next day is a working day. This means no releases on Fridays or on the day before a holiday.

Release Engineer

Background documentation

Manual updates: 2024-06-18

Release Owner

  • Update manual if applicable for any additional installation steps
  • Update the website’s release notes section in the manual
    • Using the release notes script: ./scripts/release_notes.rb foreman 3.11.0
    • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs, in
    • Headline features: half a dozen important features with a few sentences description each
    • Upgrade warnings: all important notices that users must be aware of before upgrading
    • Deprecations: anything that will be removed in a future release
    • Submit this as a PR
  • Update
    • Using redmine_release_notes script (see README as well): ./guides/doc-Release_Notes/redmine_release_notes foreman 3.11.0 > ./guides/doc-Release_Notes/topics/foreman-3.11.0.adoc
    • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to foreman-3.11.0.adoc.
    • Make sure foreman-contributors.adoc is updated
    • Make sure headline features, upgrade warnings and deprecations are in sync with the website
    • Update web/content/index.adoc and web/content/js/versions.js to declare 3.11 as stable and 3.9 as unsupported
    • Submit this as a PR
  • Update the apipie docs and place those in the foreman/3.11/apidoc directory if any changes were made to the API

After the packages have been released

Release Owner

The packages have been published since Wednesday. The Katello 4.13 packages were also published yesterday.

I just updated the release notes and am now opening the PRs to mark the latest version as stable.