Foreman 2.5.4 release process

[upadhyeammit]

Make this post a wiki

Roles

• Release Owner: @upadhyeammit
• Release Engineer: @Zhunting
• Installer Maintainer: @

Manual updates: 2021-10-19

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.

Preparing code: 2021-10-19

Installer Maintainer

• [ ] 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

Release Owner

• Add a new Redmine version for the next minor, unless the series is EOL. Be sure the version is set to sharing with subprojects.
• 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.4 in redmine. issues.rb can be used to generate a comparison between the two.
• Change Redmine version 2.5.4 state to Closed

Tagging a release: 2021-10-19

Release Owner

• In foreman 2.5-stable:
  • Make sure test_2_5_stable is green
  • Tag the release using tag.sh tag.sh 2.5.4 && 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.4 && git push upstream 2.5-stable --follow-tags
• In foreman-selinux 2.5-stable:
  • Tag the release using tag.sh tag.sh 2.5.4 && git push upstream 2.5-stable --follow-tags
• In foreman-installer 2.5-stable:
  • Tag the release using tag.sh tag.sh 2.5.4 && git push upstream 2.5-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: 2021-10-19

Note it is considered good practice to release on a day when the next day is a working day. This means no releases on Fridays or on the day before a holiday.

Release Engineer

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.
  • koji tag-build foreman-client-2.5-rhel7 foreman-release-2.5.4-1.el7
  • koji tag-build foreman-client-2.5-el8 foreman-release-2.5.4-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

Release Owner

• Update the versions on the website in version and latest news
• 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.