Foreman 3.10.0-rc1 release process

[Griffin-Sullivan]

Make this post a wiki (help)

Roles

• Release Owner: @“@Griffin-Sullivan”
• Release Engineer: @“@”

Preparing code: 2024-02-20

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

Tagging a release: 2024-02-20

Release Owner

• Check for open pull requests in Foreman, smart-proxy, foreman-installer and foreman-selinux
• Make sure test_3_10_stable and smart-proxy3.10-stable-test are green using verify_green_jobs
• Run make -C locale tx-update in foreman 3.10-stable
• Tag the projects
  • Create tags using tag_project
  • Push tags using tag_push
• Run the Jenkins Tarballs Release using release_tarballs to create tarballs

Release Engineer

• Sign Tarballs
  • download_tarballs
  • inspect_tarballs
  • Sign and upload detached signatures using 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: 2024-02-20

Release Engineer

Background documentation

• Update foreman-packaging branches
  • rpm/3.10 using bump_rpm_packaging
  • deb/3.10 using bump_deb_packaging
• Wait for packages to be built using wait_packaging (checks rpm/3.10 and deb/3.10). This takes a while so you can already start on the manual updates.
• Check for outstanding PRs against 3.10 packaging, and merge if possible:
  • rpm/3.10
  • deb/3.10
• Sign the RPMs in the release
  • generate_stage_repository
  • sign_stage_rpms
  • upload_stage_rpms
• Sign RPMs for client repos (call scripts with PROJECT=client)
  • generate_stage_repository
  • sign_stage_rpms
  • upload_stage_rpms
• Kick off the release pipeline by calling release_pipeline
• Kick off the client pipeline by calling PROJECT=client ./release_pipeline
• Kick off the plugins pipeline by calling plugins_pipeline

Manual updates: 2024-02-20

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.10.0
  • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs, in theforeman.org.
  • 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 docs.theforeman.org
  • Using redmine_release_notes script (see README as well): ./guides/doc-Release_Notes/redmine_release_notes foreman 3.10.0 > ./guides/doc-Release_Notes/topics/foreman-3.10.0.adoc
  • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to foreman-3.10.0.adoc.
  • Add topics/foreman-3.10.0.adoc to guides/doc-Release_Notes/master.adoc: sed -i '/x.y.z releases here/a include::topics/foreman-3.10.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.10 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

• Update theforeman.org
  • Update _config.yml
    • Add the 3.10 in foreman_versions list
• Create a feedback post on Discourse (like Foreman 3.8 release candidate feedback)
• Announce the release on Discourse using release_announcement
• Update the topic in #theforeman channel on Matrix
• Share the release announcement on Twitter
• Release pipeline will trigger foreman-plugins-3.10-deb-test-pipeline and foreman-plugins-3.10-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 3.10.