Foreman 2.2.0-rc2 release process

Make this post a wiki

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/2.2 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
  • Remove/change release 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 2.2.0-rc2 in redmine. issues.rb can be used to generate a comparison between the two.

Tagging a release

  • In foreman 2.2-stable:
    • Make sure test_2_2_stable is green
    • run make -C locale tx-update (if Transifex has not switched to the next major release yet, usually after .2)
    • Tag the release using tag.sh tag.sh 2.2.0-rc2
    • Push: git push upstream 2.2-stable --follow-tags
  • In smart-proxy 2.2-stable:
    • Make sure test_proxy_2_2_stable is green
    • Tag the release using tag.sh tag.sh 2.2.0-rc2
    • Push: git push upstream 2.2-stable --follow-tags
  • In foreman-selinux 2.2-stable:
    • Tag the release using tag.sh tag.sh 2.2.0-rc2
    • Push: git push upstream 2.2-stable --follow-tags
  • In foreman-installer 2.2-stable:
    • Tag the release using tag.sh tag.sh 2.2.0-rc2
    • Push: git push upstream 2.2-stable --follow-tags
  • Run the Jenkins Tarballs Release to create tarballs
  • Update release version similar to here
  • 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

Background documentation

1 Like

Due to issue with translations found during package build, this will become rc3 instead.

FWIW, foreman-tasks is currently broken on Debian, and installing it leads to a completely broken Foreman.

root@debian10-foreman-2-2:~# DEBUG=1 apt install ruby-foreman-tasks
…
+ /usr/bin/foreman-ruby /usr/bin/bundle install --local --no-prune
Running `bundle install --local --no-prune` with bundler 1.17.3
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this application for all non-root users on this machine.
Found changes from the lockfile, re-resolving dependencies because the dependencies in your gemfile changed
Resolving dependencies...
Some gems seem to be missing from your vendor/cache directory.
Bundler could not find compatible versions for gem "rack-protection":
  In snapshot (Gemfile.lock):
    rack-protection (= 2.1.0)

  In Gemfile:
    sidekiq (~> 5.0) was resolved to 5.2.9, which depends on
      rack-protection (>= 1.5.0)

    foreman-tasks (= 2.0.2) was resolved to 2.0.2, which depends on
      sinatra was resolved to 2.0.8.1, which depends on
        rack-protection (= 2.0.8.1)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.
Bundler::VersionConflict: Bundler could not find compatible versions for gem "rack-protection":
  In snapshot (Gemfile.lock):
    rack-protection (= 2.1.0)

  In Gemfile:
    sidekiq (~> 5.0) was resolved to 5.2.9, which depends on
      rack-protection (>= 1.5.0)

    foreman-tasks (= 2.0.2) was resolved to 2.0.2, which depends on
      sinatra was resolved to 2.0.8.1, which depends on
        rack-protection (= 2.0.8.1)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.

Fixes for develop: https://github.com/theforeman/foreman-packaging/pull/5817
and 2.2: https://github.com/theforeman/foreman-packaging/pull/5818

The same will need to happen for 2.1 and 2.0 if we do core releases there (or the same bug is present already, I didn’t check, it should happen on all core builds after September 4th)

1 Like