Foreman 1.23.0 release process

Manual updates

  • 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
    • Headline features: half a dozen important features with a few sentences description each
    • Upgrade notes: all important notices that users must be aware of before upgrading
  • Update installer options section using the get-params script (Note: this step can only be done after packages are released)
  • Generate the apipie doc and place it in the api/1.23 directory

Preparing code

  • 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
  • Compare tagged packages in nightly vs. release koji tag and re-tag any updated dependencies that are required
  • 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 release field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
  • Change Redmine version 1.23.0 state to Closed
  • Ensure that code in git matches issues fixed in 1.23.0 in redmine. issues.rb can be used to generate a comparison between the two.

Tagging a release

  • In foreman 1.23-stable:
    • Make sure test_1_23_stable is green
    • run make -C locale tx-update (if Transifex has not switched to the next major release yet, usually after .2)
    • run script/
    • update template snapshots with rake snapshots:generate RAILS_ENV=test and verify changes are expected
    • Tag the release using 1.23.0
    • Push: git push upstream 1.23-stable --follow-tags
  • In smart-proxy 1.23-stable:
  • In foreman-selinux 1.23-stable:
    • Tag the release using 1.23.0
    • Push: git push upstream 1.23-stable --follow-tags
  • In foreman-installer 1.23-stable:
    • Tag the release using 1.23.0
    • Push: git push upstream 1.23-stable --follow-tags
  • Run the Jenkins Tarballs Release to create 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

Background documentation

@tbrisker Debian packages are still building but RPMs are signed. Whenever has completed successfully you should be able to kick off the release pipeline to do the GA release.