Foreman 3.16 branching process

lhellebr · July 31, 2025, 12:46pm

Make this post a wiki (help)

Roles

Ensure headline features planned for the release have been merged or push them off to the next release.
Translations:
- Update locales in foreman develop: make -C locale tx-update - PR
- Ask plugin authors to start extracting i18n strings and pushing the changes into develop/master git branches so Transifex can pick it up - Sent a message to the Foreman dev channel
- Announce string freeze date on Discourse and send announcement - Discourse post
- Update foreman-dev with translations status (click on Report) to encourage 100% translations before release

Announce start of stabilization week to discourse development category.
Request new Hammer CLI release from maintainers if needed. - Matrix message
Prepare the manual for the new version: - PR
- Update installer options section of nightly manual using the get-params script
- Copy website manual content from nightly to 3.16 and update version numbers mentioned in it.
  - cp -r manuals/nightly manuals/3.16
  - cp -r _includes/manuals/nightly _includes/manuals/3.16
  - sed -i 's/nightly/3.16/i' manuals/3.16/*.md
  - sed -i '/previous_version/ s/: .\+/: "3.16"/' manuals/nightly/index.md
  - sed -i '/- nightly/a \ \ - "3.16"' _config.yml
- Clean up deprecation and upgrade warnings from nightly manual for in both foreman.adoc and katello.adoc. - no deprecations
Add new languages that are at a reasonable completion on Transifex to develop

Create new GPG key for release. See GPG_Keys if needed.
- generate_gpg
- export_gpg_private to back up
- sign_gpg
- upload_gpg
Publish the key
- Use export_gpg_public to show the GPG key and update the website’s security.md and create a file in static/keys - PR
- Use upload_yum_gpg to create releases/3.16/RPM-GPG-KEY-foreman on yum.theforeman.org
- Make sure the settings file contains the right OSES list. It should match what is in the nightly settings file
- Commit the settings file to the theforeman-rel-eng repository - PR
Create new settings files for client, ensure it has the rights OSES list and commit it too. - PR
Open a PR with the result of jenkins-jobs branching: ./branch-foreman 3.16 KATELLO_VERSION - PR
Open PR to remove any jobs that are related to end of life versions - PR
Open PR to add 3.16 to Forklift versions config. Once the PR is merged, upgrade pipelines will fail, so do not merge it before packaging has been branched. - PR

Branch RPM packaging
- Create a rpm/3.16 branch in foreman-packaging based on rpm/develop: git checkout rpm/develop && git pull && git checkout -b rpm/3.16
- Update foreman_version in package_manifest.yaml on the rpm/3.16 branch: sed -i '/foreman_version:/ s/nightly/3.16/' package_manifest.yaml
- Update katello_version in package_manifest.yaml on the rpm/3.16 branch: sed -i '/katello_version:/ s/nightly/KATELLO_VERSION_HERE/' package_manifest.yaml
- Create release repositories in Copr by forking nightly repositories obal copr-project copr_projects on the rpm/3.16 branch
- Push the rpm/3.16 branch
Branch Debian packaging
- Clone Debian nightly repos to 3.16 using copy/freight instructions
- Create a deb/3.16 branch in foreman-packaging based on deb/develop

Create 3.16-stable branches using branch_project
Push 3.16-stable branches using branch_push
Branch foreman-documentation git repository and update website for new release by following the README instructions
Ask Hammer maintainer to branch hammer-cli and hammer-cli-foreman - message in the Matrix channel

The next step should only be done after all branching, including packaging, has completed.

Bump versions to 3.17-develop using develop_branch_bump
Push version bumps to 3.17-develop using develop_branch_push
Create Redmine version 3.17.0 and make sure it is shared with subprojects in foreman
Ask Hammer maintainer to bump hammer-cli and hammer-cli-foreman

Merge the earlier created jenkins-jobs PR that creates the release pipelines
Update foreman-packaging rpm/develop to ensure nightlies build:
- rpm/develop:
  - Update the build tag: sed -i 's/fm3_16/fm3_17/g' package_manifest.yaml
  - Set to version 3.17.0, reset release to 1: sed -i '/^Version:/ s/[0-9\.]\+$/3.17.0/ ; /^%global release/ s/[0-9]\+$/1/' packages/foreman/foreman{,-{installer,proxy,release,selinux}}/*.spec packages/foreman/rubygem-hammer_cli{,_foreman}/*.spec
  - Create a changelog using obal changelog --message '- Bump version to 3.17-develop' foreman{,-{installer,proxy,release,selinux}} rubygem-hammer_cli{,_foreman}
  - Commit: git commit -a -m 'Bump version to 3.17-develop'
- deb/develop: scripts/changelog.rb -v 3.17.0-1 -m "Bump changelog to 3.17.0 to match VERSION" debian/*/*/changelog
Prepare build systems for 3.16 release:
- foreman-packaging’s rpm/3.16
  - Update packages/foreman/foreman-release/foreman.gpg, mock/*.cfg, package_manifest.yaml and repoclosure/*.conf
- foreman-packaging’s deb/3.16
  - Update debian/*/foreman-release/theforeman-archive-keyring.asc from https://deb.theforeman.org/foreman.asc, you will only see changes if the key was recently updated.
Trigger the foreman-packaging-rpm-3.16 job once, so that GitHub hooks are properly set up.
Trigger the foreman-packaging-deb-3.16 job once, so that GitHub hooks are properly set up.

Create the 3.16.0-rc release procedure in Development/Releases: PROJECT=foreman VERSION=3.16 ./procedure_release 2025-08-12 '@lhellebr' '@ogajduse' | wl-copy
Create a Foreman 3.17 Schedule and Planning post on Development/Releases using schedule: ./schedule 2025-08-13 (make sure there are no conflicts with other important dates)
Ask on Discourse Developers to remove Foreman deprecations for the next release in develop

This was based on the wiki procedure and sometimes has a bit more info.