Make this post a wiki
Roles
Manual updates: 2022-12-14
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.rb foreman 3.5.0 - 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 warnings: all important notices that users must be aware of before upgrading
- Deprecations: anything that will be removed in a future release
- 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.5.0 > ./guides/doc-Release_Notes/topics/foreman-3.5.0.adoc - Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to
foreman-3.5.0.adoc. - Add
topics/foreman-3.5.0.adoctoguides/doc-Release_Notes/master.adoc:sed -i '/x.y.z releases here/a include::topics/foreman-3.5.0.adoc[leveloffset=+1]' guides/doc-Release_Notes/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.5/apidoc directory if any changes were made to the API
Preparing code: 2022-12-14
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
- 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 in redmine. issues.rb can be used to generate a comparison between the two.
- Change Redmine version 3.5.0 state to Closed
Tagging a release: 2022-12-14
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-12-14
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
yggdrasilintoforeman-plugins-3.5-el8, as this doesn’t happen automatically: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
- Update installer options section using the get-params script (Note: this step can only be done after packages are released)
- Update the versions on the website in version and latest news
-
Update the
foreman_versionto 3.5 in website’s_config.ymlfile -
Update the docs.theforeman.org index page and versions,
-
Update 3.5 as
supported -
Update 3.3 as
unsupported
-
Update 3.5 as
- Announce the release on Discourse
- Update the topic in #theforeman channel on Libera.Chat
- Share the release announcement on Twitter
-
After about a week, update
stableversion in foreman-infra - 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.