Foreman 3.8.0-rc2 release process

Make this post a wiki (help)


Preparing code: 2023-09-19

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

Tagging a release: 2023-09-19

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: 2023-09-19

Release Engineer

Background documentation

Manual updates: 2023-09-19

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.8.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.8.0 > ./guides/doc-Release_Notes/topics/foreman-3.8.0.adoc
    • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to foreman-3.8.0.adoc.
    • Add topics/foreman-3.8.0.adoc to guides/doc-Release_Notes/master.adoc: sed -i '/x.y.z releases here/a include::topics/foreman-3.8.0.adoc[leveloffset=+1]' guides/doc-Release_Notes/master.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 add 3.8 as a release candidate
    • Submit this as a PR
  • Generate the apipie docs and raise pull request in apidocs repository

After the packages have been released

Release Owner

Cherry picks for Foreman 3.8.0-rc2 by ekohl · Pull Request #881 · theforeman/foreman-installer · GitHub should be the changes for Foreman 3.8.0-rc2.

Packaging PRs are up:

1 Like