This procedure was generated from procedures/foreman/release.md.erb at 892ddbdf07094a72eb62797b7aa9c43f3016a1f1
Make this post a wiki (help)
Roles
Preparing code: 2026-05-26
Installer Maintainer
- 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
Release Owner
- Make sure any release blocking issues are resolved and remove/change target version field for any open Redmine tickets assigned to the release still (next minor, unset it or reject). Look for the
3.19.0 release TODOsaved query on Foreman’s issues. - Ensure that code in git matches issues fixed in 3.19.0-rc2 in Redmine. Use the
3.19.0 release DONEsaved query on Foreman’s issues. issues can be used to generate a comparison between the two. - Check for open pull requests in Foreman, smart-proxy, foreman-installer and foreman-selinux
gh search prs --state=open --base=3.19-stable --repo=theforeman/foreman --repo=theforeman/smart-proxy --repo=theforeman/foreman-installer --repo=theforeman/foreman-selinux
Tagging a release: 2026-05-26
Release Owner
- Make sure foreman-3.19-stable-test and smart-proxy-3.19-stable-test are green using verify_green_jobs
- Run
make -C locale tx-updatein foreman 3.19-stable - Update release version similar to here
- Tag the projects
- Create tags using tag_project
- Push tags using tag_push
- Run the Jenkins Tarballs Release using release_tarballs to create tarballs
Release Engineer
- Sign Tarballs
- download_tarballs
- inspect_tarballs
- Sign and upload detached signatures using 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: 2026-05-26
Release Engineer
- Update foreman-packaging branches
- rpm/3.19 using bump_rpm_packaging
- deb/3.19 using bump_deb_packaging
- Wait for packages to be built using wait_packaging (checks rpm/3.19 and deb/3.19). This takes a while so you can already start on the manual updates.
- Check for outstanding PRs against 3.19 packaging, and merge if possible:
- Sign the RPMs in the release
- Sign RPMs for client repos (call scripts with
PROJECT=client) - Kick off the release pipeline by calling release_pipeline
- Kick off the client pipeline by calling
PROJECT=client ./release_pipeline - Kick off the plugins pipeline by calling plugins_pipeline
Konflux OCI Image Branching
Run after RPM branching is complete and packages appear in the versioned repo.
Use either the orchestrator script or follow the manual runbook linked below.
Documentation:
Prerequisites:
-
Tools installed:
uv,git,gh,glab,yq,jq,kustomize,oc -
GitHub forks: foreman-oci-images, pulp-oci-images, candlepin-oci-images
-
GitLab fork: tenants-config
-
Env vars:
FOREMAN_VERSION=3.19,GITHUB_USER,GITLAB_USER
Steps:
- Dry-run first:
uv run hack/branch-release/branch_konflux --version=3.19 --dry-run - Execute:
uv run hack/branch-release/branch_konflux --version=3.19
Creates branchforeman-3.19and opens draft PRs/MR in: - Review and merge the 3 OCI repo PRs
- Wait for RPMs:
https://yum.theforeman.org/releases/3.19/el9/x86_64/repodata/repomd.xml - Merge tenants-config MR (registers
foreman-3.19components in Konflux) - Verify first
3.19build succeeds in Konflux UI
Published images (after all steps complete):
quay.io/theforeman/foreman:3.19,quay.io/theforeman/foreman-proxy:3.19quay.io/theforeman/foreman:3.19.0-rc2,quay.io/theforeman/foreman-proxy:3.19.0-rc2quay.io/theforeman/pulp:3.105,quay.io/theforeman/pulp:foreman-3.19quay.io/theforeman/candlepin:4.7,quay.io/theforeman/candlepin:4.7.5,quay.io/theforeman/candlepin:foreman-3.19
Manual updates: 2026-05-26
Release Owner
- Update manual if applicable for any additional installation steps
- Update the website’s release notes section in the manual
- Using the release notes script:
./scripts/release_notes.rb foreman 3.19.0 - Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs, in theforeman.org.
- Headline features: half a dozen important features with a few sentences description each
- Upgrade warnings: all important notices that users must be aware of before upgrading
- Deprecations: anything that will be removed in a future release
- Submit this as a PR
- Using the release notes script:
- Update docs.theforeman.org
- Using redmine_release_notes script (see README as well):
./guides/doc-Release_Notes/redmine_release_notes foreman 3.19.0 > ./guides/doc-Release_Notes/topics/foreman-3.19.0.adoc - Append CLI release notes taken from the hammer-cli and hammer-cli-foreman changelogs to
foreman-3.19.0.adoc. - Make sure foreman-contributors.adoc is updated
- Make sure headline features, upgrade warnings and deprecations are in sync with the website
- Submit this as a PR
- Using redmine_release_notes script (see README as well):
- Update the apipie docs and place those in the foreman/3.19/apidoc directory if any changes were made to the API
After the packages have been released
Release Owner
- Update theforeman.org
- Update installer options section using the get-params script (Note: this step can only be done after packages are released)
- Announce the release on Discourse using release_announcement
- Update the topic in #theforeman channel on Matrix
- Release pipeline will trigger foreman-plugins-3.19-deb-test-pipeline and foreman-plugins-3.19-rpm-test-pipeline. These don’t block releases but can be used to understand known issues around plugin compatibility with Foreman 3.19.