Foreman 1.24.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

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
  • Remove/change release field for any open Redmine tickets assigned to the release still (next minor, unset it or reject)
  • Change Redmine version 1.24.0 state to Closed
  • Ensure that code in git matches issues fixed in 1.24.0 in redmine. issues.rb can be used to generate a comparison between the two.

Tagging a release

  • In foreman 1.24-stable:
    • Make sure test_1_24_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/sync_templates.sh
    • update template snapshots with rake snapshots:generate RAILS_ENV=test and verify changes are expected
    • Tag the release using tag.sh tag.sh 1.24.0
    • Push: git push upstream 1.24-stable --follow-tags
  • In smart-proxy 1.24-stable:
  • In foreman-selinux 1.24-stable:
    • Tag the release using tag.sh tag.sh 1.24.0
    • Push: git push upstream 1.24-stable --follow-tags
  • In foreman-installer 1.24-stable:
    • Tag the release using tag.sh tag.sh 1.24.0
    • Push: git push upstream 1.24-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

I’m working on the RPM packaging side. I’m currently blocked setting up a release environment:

ehelms@woodford theforeman-rel-eng (master)$ ./sign_tarballs 
It seems you are new to gopass. Do you want to run the onboarding wizard? [Y/n/q]: n
Entry 'theforeman/releases/foreman/1.24-gpg' not found. Starting search...

Error: failed to list store: lstat /home/ehelms/.password-store: no such file or directory

@ekohl @evgeni – can you help me with what I am missing setting things up?

After installing gopass, you need to clone the two password stores:

gopass clone --sync gitcli puppetmaster.theforeman.org:/srv/secretsgit/theforeman-release.git theforeman/releases
gopass clone --sync gitcli puppetmaster.theforeman.org:/srv/secretsgit/theforeman-passwords.git theforeman/shared

@evgeni Can you please sign the RPMs for me in the morning?

done for foreman and client.

added late comming hammer_foreman 0.19.4 and re-running the pipe