Foreman 3.2.0-rc1 release process

[upadhyeammit]

Make this post a wiki

Roles

• Release Owner: @upadhyeammit
• Release Engineer: @zhunting

Manual updates: 2022-02-14

Release Engineer

• 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 docs and raise pull request in apidocs repository

Preparing code: 2022-02-14

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

Tagging a release: 2022-02-14

Release Owner

• In foreman 3.2-stable:
  • Make sure test_3_2_stable is green
  • run make -C locale tx-update
  • Tag the release using tag.sh tag.sh 3.2.0-rc1 && git push upstream 3.2-stable --follow-tags
• In smart-proxy 3.2-stable:
  • Make sure test_proxy_3_2_stable is green
  • Tag the release using tag.sh tag.sh 3.2.0-rc1 && git push upstream 3.2-stable --follow-tags
• In foreman-selinux 3.2-stable:
  • Tag the release using tag.sh tag.sh 3.2.0-rc1 && git push upstream 3.2-stable --follow-tags
• In foreman-installer 3.2-stable:
  • Tag the release using tag.sh tag.sh 3.2.0-rc1 && git push upstream 3.2-stable --follow-tags
• Run the Jenkins Tarballs Release to create tarballs

Release Engineer

• 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: 2022-02-14

Release Engineer

Background documentation

• Update foreman-packaging branches
  • rpm/3.2
  • deb/3.2
• Wait for packages to be built
  • rpm/3.2
  • deb/3.2
• Tag foreman-release into foreman-client-3.2-rhel7 and foreman-client-3.2-el8, as this doesn’t happen automatically for those tags. Make sure the build matches the release.
  • koji tag-build foreman-client-3.2-rhel7 foreman-release-3.2.0-1.el7
  • koji tag-build foreman-client-3.2-el8 foreman-release-3.2.0-1.el8
• Check for outstanding PRs against 3.2 packaging, and merge if possible:
  • rpm/3.2
  • deb/3.2
• 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

Release Owner

• Add the 3.2 in foreman_versions list in website’s _config.yml file
• 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-3.2-deb-test-pipeline and foreman-plugins-3.2-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 3.2.

[Zhunting]

I’ve managed to make it most of the way through the release process, the last remaining issue being have our release pipeline have a complete run. For now though it seems that Centos infra is having issues which leaves us unable to properly run parts of the release process. Hopefully these issues will clear up by tomorrow and we can finish the process.

I’m having another issue with the deb release though, where it seems to be unable to find a version of Kafo to properly use which I’ll try and ask better deb minds what may be occuring there.