Foreman 2.5.0-rc3 release process

[upadhyeammit]

Make this post a wiki

Manual updates: 2021-05-19

• 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.5 directory

Preparing code: 2021-05-19

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

Tagging a release: 2021-05-19

• In foreman 2.5-stable:
  • Make sure test_2_5_stable is green
  • run make -C locale tx-update
  • Tag the release using tag.sh tag.sh 2.5.0-rc3 && git push upstream 2.5-stable --follow-tags
• In smart-proxy 2.5-stable:
  • Make sure test_proxy_2_5_stable is green
  • Tag the release using tag.sh tag.sh 2.5.0-rc3 && git push upstream 2.5-stable --follow-tags
• In foreman-selinux 2.5-stable:
  • Tag the release using tag.sh tag.sh 2.5.0-rc3 && git push upstream 2.5-stable --follow-tags
• In foreman-installer 2.5-stable:
  • Tag the release using tag.sh tag.sh 2.5.0-rc3 && git push upstream 2.5-stable --follow-tags
• Run the Jenkins Tarballs Release to create tarballs
• Update release version similar to here
• Sign Tarballs
  • Download
  • Inspect
  • Sign and upload detached signatures

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-05-19

Background documentation

• Update foreman-packaging
  • rpm/2.5
  • deb/2.5 branches
• Trigger release_packages in Jenkins by calling release_packages script.
• Tag foreman-release into foreman-client-2.5-rhel7 and foreman-client-2.5-el8, as this doesn’t happen automatically for those tags. Make sure the build matches the release.
  • koji tag-build foreman-client-2.5-rhel7 foreman-release-2.5.0-1.el7
  • koji tag-build foreman-client-2.5-el8 foreman-release-2.5.0-1.el8
• Check for outstanding PRs against 2.5 packaging, and merge if possible:
  • rpm/2.5
  • deb/2.5
• Sign the RPMs in the release
  • Download
  • Sign
  • Upload RPM signatures
  • Upload RPMs
• Sign RPMs for client repos (call scripts with PROJECT=client)
  • Download
  • Sign
  • Upload RPM signatures
  • Upload 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

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 foreman-plugins-2.5-deb-test-pipeline and foreman-plugins-2.5-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 2.5.