Foreman 5.0 branching process

Development Releases
1

This procedure was generated from procedures/foreman/branch.md.erb at 9f1c697aa41c515649c0fb07cff80f969791c048

Make this post a wiki (help)

Roles

Prep Week: 2026-07-27 to 2026-07-31

Installer Maintainer

Release Owner

  • Ensure headline features planned for the release have been merged or push them off to the next release.
  • Translations:
    • Setup Transifex CLI if not already installed: Follow the Transifex CLI documentation for installation and authentication setup
    • Update locales in foreman develop: make -C locale tx-update
    • Coordinate with plugin authors to extract i18n strings:
      • Ask plugin authors to start extracting i18n strings and pushing the changes into develop/master git branches so Transifex can pick it up (send a message in the Matrix channel)
    • Work with Transifex for translation status and announcements:
      • Export translation statistics from Transifex (click on Report) and save as foreman_foreman.languages.csv. See this help article on how to generate the report for all languages.
      • Post string freeze announcement to foreman-dev using string_freeze_announcement script: ./string_freeze_announcement foreman_foreman.languages.csv BRANCHING_DATE RC1_DATE RC2_DATE PLANNING_URL to encourage 100% translations before release
      • Send a project-level announcement on Transifex about the string freeze using transifex_announcement script: ./transifex_announcement GA_DATE SCHEDULE_URL PLANNING_URL
    • Track translation work in project management:

Stabilization Week: 2026-08-03 to 2026-08-07

Release Owner

  • Announce start of stabilization week to discourse development category.
  • Request new Hammer CLI release from maintainers if needed.
  • Update Hammer CLI packaging once the Hammer CLI release is ready:
    • RPM: Update rubygem-hammer_cli and rubygem-hammer_cli_foreman in rpm/5.0 branch
      • obal update rubygem-hammer_cli --version 5.0.0
      • obal update rubygem-hammer_cli_foreman --version 5.0.0
    • DEB: Update packaging in deb/develop and cherry-pick the changes to deb/5.0
      • deb/develop is updated by automation, ensure that happened
      • Cherry-pick the changes to deb/5.0
  • Prepare the manual for the new version:
    • Update installer options section of nightly manual using the get-params script
    • Copy website manual content from nightly to 5.0 and update version numbers mentioned in it.
      • cp -r manuals/nightly manuals/5.0
      • cp -r _includes/manuals/nightly _includes/manuals/5.0
      • sed -i 's/nightly/5.0/i' manuals/5.0/*.md
      • sed -i '/previous_version/ s/: .\+/: "5.0"/' manuals/nightly/index.md
      • sed -i '/- nightly/a \ \ - "5.0"' _config.yml
    • Clean up deprecation and upgrade warnings from nightly manual for in both foreman.adoc and katello.adoc.
    • Commit the manual changes: git commit -a -m "Add Foreman 5.0 manual and update nightly" and create a pull request
  • Add new languages that are at a reasonable completion on Transifex to develop

Release Engineer

Branching: 2026-08-11

Release Engineer

  • Branch RPM packaging
    • Create a rpm/5.0 branch in foreman-packaging based on rpm/develop: git checkout rpm/develop && git pull && git checkout -b rpm/5.0
    • Update foreman_version in package_manifest.yaml on the rpm/5.0 branch: sed -i '/foreman_version:/ s/nightly/5.0/' package_manifest.yaml
    • Update katello_version in package_manifest.yaml on the rpm/5.0 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/5.0 branch
    • Push the rpm/5.0 branch
  • Branch Debian packaging

Release Owner

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

Preparing build systems: 2026-08-11

Release engineer

  • 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/fm5_0/fm5_1/g' package_manifest.yaml
      • Set to version 5.1.0, reset release to 1: sed -i '/^Version:/ s/[0-9\.]\+$/5.1.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 5.1-develop' foreman{,-{installer,proxy,release,selinux}} rubygem-hammer_cli{,_foreman}
      • Commit: git commit -a -m 'Bump version to 5.1-develop'
    • deb/develop: scripts/changelog.rb -v 5.1.0-1 -m "Bump changelog to 5.1.0 to match VERSION" debian/*/*/changelog
  • Prepare build systems for 5.0 release:
    • foreman-packaging’s rpm/5.0
      • Update packages/foreman/foreman-release/foreman.gpg, mock/*.cfg, package_manifest.yaml and repoclosure/*.conf and commit with message: git commit -a -m "Foreman 5.0 branching build updates". See example patch
    • foreman-packaging’s deb/5.0
      • 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, and commit with message: git commit -a -m "Foreman 5.0 keyring updates"
  • Trigger the foreman-packaging-rpm-5.0 job once, so that GitHub hooks are properly set up.
  • Trigger the foreman-packaging-deb-5.0 job once, so that GitHub hooks are properly set up.

Other systems: 2026-08-11

Release Owner

  • Create the 5.0.0-rc release procedure in Development/Releases: PROJECT=foreman VERSION=5.0 ./procedure_release 2026-08-11 '@ogajduse' '@ogajduse' | wl-copy
  • Create a Foreman 5.1 Schedule and Planning post on Development/Releases using schedule: ./schedule 2026-08-12 (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.

Foreman 5.0 Stabilization Week starts today!
Release Team Meeting 2026-07-22