Make this post a wiki
Roles
Manual updates: 2022-11-23
Release Owner
- Update manual if applicable for any additional installation steps
-
Update the website’s release notes section in the manual
- Using the release notes script:
./scripts/release_notes foreman 3.4.1 - Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs, in theforeman.org and docs.theforeman.org websites release notes.
- Submit this as a PR
- Using the release notes script:
-
Update docs.theforeman.org
- Using redmine_release_notes script (see README as well):
./guides/doc-Release_Notes/redmine_release_notes foreman 3.4.1 > ./guides/doc-Release_Notes/topics/foreman-3.4.1.adoc - Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to
foreman-3.4.1.adoc. - Add
topics/foreman-3.4.1.adoctoguides/doc-Release_Notes/master.adoc:sed '/x.y.z releases here/a include::topics/foreman-3.4.1.adoc[leveloffset=+1]' master.adoc - Make sure foreman-contributors.adoc is updated
- Make sure headline features, upgrade warnings and deprecations are in sync with the website
- Submit this as a PR
- Using redmine_release_notes script (see README as well):
- Update the apipie docs and place those in the foreman/3.4/apidoc directory if any changes were made to the API
Preparing code: 2022-11-23
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 3.4.1 in redmine. issues.rb can be used to generate a comparison between the two.
- Change Redmine version 3.4.1 state to Closed
Tagging a release: 2022-11-23
Release Owner
- Make sure test_3_4_stable and test_3_4_stable are green using verify_green_jobs
- 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-23
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
- Update foreman-packaging branches
- Wait for packages to be built
-
Tag
foreman-releaseintoforeman-client-3.4-rhel7andforeman-client-3.4-el8, as this doesn’t happen automatically for those tags.-
koji tag-build foreman-client-3.4-rhel7 foreman-release-3.4.1-1.el7 -
koji tag-build foreman-client-3.4-el8 foreman-release-3.4.1-1.el8
-
-
Tag
yggdrasilintoforeman-plugins-3.4-nonscl-rhel7andforeman-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:
- 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
- Update the versions on the website in version and latest news
- 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.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.