Foreman 3.1.1 release process

Make this post a wiki


Manual updates: 2022-01-25

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.
    • CLI release notes are taken from the hammer-cli and hammer-cli-foreman changelogs
    • Link to installer changelogs and note versions being used
  • Update installer options section using the get-params script if any changes were made in the installer or installer modules (after new packages have been released)
  • Update the apipie docs and place those in the foreman/3.1/apidoc directory if any changes were made to the API

Preparing code: 2022-01-25

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.1.1 in redmine. issues.rb can be used to generate a comparison between the two.
  • Change Redmine version 3.1.1 state to Closed

Tagging a release: 2022-01-25

Release Owner

  • In foreman 3.1-stable:
    • Make sure test_3_1_stable is green
    • Tag the release using 3.1.1 && git push upstream 3.1-stable --follow-tags
  • In smart-proxy 3.1-stable:
  • In foreman-selinux 3.1-stable:
    • Tag the release using 3.1.1 && git push upstream 3.1-stable --follow-tags
  • In foreman-installer 3.1-stable:
    • Tag the release using 3.1.1 && git push upstream 3.1-stable --follow-tags
  • Run the Jenkins Tarballs Release to create tarballs

Release Engineer

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-01-25

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

After the packages have been released

Release Owner

Tarballs release job is running: tarballs-release #95 [Jenkins]

@Odilhao please run the rel-eng tasks.

The PR for the release notes is open: Release Foreman 3.1.1 by ekohl · Pull Request #1945 · theforeman/ · GitHub