Foreman 3.4.0-rc1 release process

[upadhyeammit]

Make this post a wiki

Roles

• Release Owner: @upadhyeammit
• Release Engineer: @pcreech

Manual updates: 2022-08-11

Release Owner

• 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.
    • For theforeman.org: You can auto-generate changes using the release notes script.
    • For docs.theforeman.org: You can auto-generate changes using redmine_release_notes script, more details are available in README.
  • Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs, in theforeman.org and docs.theforeman.org websites release notes.
  • Headline features: half a dozen important features with a few sentences description each
  • Upgrade notes on theforeman.org and docs.theforeman.org: all important notices that users must be aware of before upgrading
    Generate the apipie docs and raise pull request in apidocs repository

Preparing code: 2022-08-11

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

Tagging a release: 2022-08-11

Release Owner

• In foreman 3.4-stable:
  • Make sure test_3_4_stable is green
  • run make -C locale tx-update
  • Tag the release using tag.sh tag.sh 3.4.0-rc1 && git push upstream 3.4-stable --follow-tags
• In smart-proxy 3.4-stable:
  • Make sure test_proxy_3_4_stable is green
  • Tag the release using tag.sh tag.sh 3.4.0-rc1 && git push upstream 3.4-stable --follow-tags
• In foreman-selinux 3.4-stable:
  • Tag the release using tag.sh tag.sh 3.4.0-rc1 && git push upstream 3.4-stable --follow-tags
• In foreman-installer 3.4-stable:
  • Tag the release using tag.sh tag.sh 3.4.0-rc1 && git push upstream 3.4-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-08-11

Release Engineer

Background documentation

• Update foreman-packaging branches
  • rpm/3.4
  • deb/3.4
• Wait for packages to be built
  • rpm/3.4
  • deb/3.4
• Tag foreman-release into foreman-client-3.4-rhel7 and foreman-client-3.4-el8, as this doesn’t happen automatically for those tags. Make sure the build matches the release.
  • koji tag-build foreman-client-3.4-rhel7 foreman-release-3.4.0-1.el7
  • koji tag-build foreman-client-3.4-el8 foreman-release-3.4.0-1.el8
• Tag yggdrasil into foreman-plugins-3.4-nonscl-rhel7 and foreman-plugins-3.4-el8, as this doesn’t happen automatically for those tags.
  • koji tag-build foreman-plugins-3.4-el8 yggdrasil-VERSION.el8
• Check for outstanding PRs against 3.4 packaging, and merge if possible:
  • rpm/3.4
  • deb/3.4
• 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.4 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.4-deb-test-pipeline and foreman-plugins-3.4-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 3.4.

[evgeni]

# cat /etc/apt/sources.list.d/foreman.list 
deb [signed-by=/usr/share/keyrings/theforeman-archive-keyring.asc] http://deb.theforeman.org/ bullseye 3.4.0~rc1
deb [signed-by=/usr/share/keyrings/theforeman-archive-keyring.asc] http://deb.theforeman.org/ plugins 3.4.0~rc1

well, this didn’t work exactly how we wanted, will have to investigate a bit more XD

Probably needs something like a sed -E 's/([0-9]+\.[0-9]+).*/\1/' or so, but Monday.

[evgeni]

@evgeni

s/([0-9]+.[0-9]+).*/\1/

Here is the PR against deb/develop that fixes it: https://github.com/theforeman/foreman-packaging/pull/8353
will need to be picked to deb/3.4 once merged.