Make this post a wiki
Roles
Manual updates: 2022-11-08
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
-
Release notes: bullet point list by category of all changes, include link to bug numbers.
-
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-11-08
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.5.0-rc1 in redmine. issues.rb can be used to generate a comparison between the two.
Tagging a release: 2022-11-08
Release Owner
- Make sure test_3_5_stable and test_3_5_stable are green using verify_green_jobs
-
Run
make -C locale tx-updatein foreman 3.5-stable - Update release version similar to here
-
Tag the projects
- Create tags tag_project
- Push tags tag_push
- Run the Jenkins Tarballs Release using release_tarballs to create tarballs
Release Engineer
- 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: 2022-11-08
Release Engineer
- Update foreman-packaging branches
- Wait for packages to be built
-
Tag
foreman-releaseintoforeman-client-3.5-rhel7andforeman-client-3.5-el8, as this doesn’t happen automatically for those tags. Make sure the build matches the release.-
koji tag-build foreman-client-3.5-rhel7 foreman-release-3.5.0-1.el7 -
koji tag-build foreman-client-3.5-el8 foreman-release-3.5.0-1.el8
-
-
Tag
yggdrasilintoforeman-plugins-3.5-nonscl-rhel7andforeman-plugins-3.5-el8, as this doesn’t happen automatically for those tags.-
koji tag-build foreman-plugins-3.5-el8 yggdrasil-VERSION.el8
-
- Check for outstanding PRs against 3.5 packaging, and merge if possible:
- Sign the RPMs in the release
-
Sign RPMs for client repos (call scripts with
PROJECT=client) -
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.5 in
foreman_versionslist in website’s_config.ymlfile - Announce the release on Discourse
- Update the topic in #theforeman channel on Libera.Chat
- Share the release announcement on Twitter
- Release pipeline will trigger foreman-plugins-3.5-deb-test-pipeline and foreman-plugins-3.5-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 3.5.