Skip to main content

Packaging Multi-Linux Manager

Package the English Multi-Linux Manager documentation from a maintenance branch. Update config.yml and run task container:obs:mlm.

Configuring your OBS user account is out of scope for this page. You need osc installed and working against https://api.suse.de.

For setup, see Container setup.


1. Create the maintenance branch​

Create the maintenance branch from the major branch before you change config.yml. Check out the major branch, such as manager-5.2 or manager-5.1, then create the release branch. Name it manager-X.Y-MU-X.Y.Z, for example manager-5.2-MU-5.2.2.

cd uyuni-docs
git checkout manager-5.2
git pull --ff-only origin manager-5.2
git checkout -b manager-5.2-MU-5.2.2
git push --set-upstream origin manager-5.2-MU-5.2.2

Replace manager-5.2 with the major branch for this release, and 5.2.2 with the maintenance version. Do the rest of this page on that branch.


2. Update config.yml​

On the maintenance branch, update config.yml before you build. Field reference: config.yml.

Under products.mlm.asciidoc.attributes:

FieldWhat to set
productnumberRelease number, quoted so a trailing zero is kept ("5.2" or "5.1")
productchartversionHelm chart version for this release
gitchartsbranchCharts branch for this release
copyrightdateCopyright range, when the year has changed

Then review supported client versions in the shared asciidoc: block. Confirm the list and versions with the release managers and the product owner before you package.


3. Build the English OBS packages​

cd uyuni-docs
task container:build # once, or after Dockerfile.bci changes
task container:obs:mlm LANGUAGES=en

English packages land in build/packages/ on the host.

Then follow the section for the branch you are packaging.


manager-5.2​

Packaging for manager-5.2 happens on internal GitLab: src.suse.de/Galaxy/susemanager-docs_en.

  1. Fork src.suse.de/Galaxy/susemanager-docs_en and clone your fork.

  2. Copy the English packages from uyuni-docs/build/packages/ into the package directory in your fork. Ship the en build only.

  3. Update the .spec file Version: to the release version.

  4. Add the changelog with osc vc. Always use this command. It inserts the build-service header: the dashed line, then the date, name, and email. Do not write that header by hand.

    osc vc susemanager-docs_en.changes

    Under the header, add the entries from uyuni-docs/.changelog. The entry must match the existing susemanager-docs_en.changes syntax: a * Version line, then - bullets. Indent wrapped lines, and put a Bugzilla reference at the end of a bullet when you have one.

    -------------------------------------------------------------------
    Wed Aug 19 12:52:39 UTC 2026 - Your Name <your.name@suse.com>

    * Version 5.2.1
    - Documented requirements and limitations for container image
    inspection on SLES 15 and SLES 16 (bsc#1274720)
    - Documented proxy certificate replacement using spacecmd
    (bsc#1271329)
  5. Commit and open a pull request against the upstream package repo.


manager-5.1​

Packaging for manager-5.1 happens on OBS: Devel:Galaxy:Manager:5.1 at build.suse.de.

The SUMA product docs IBS wiki still describes the older helper-script build. Use it only as a reference for the OBS checkout, changelog, and service-request steps below. Do not use uyuni-docs-helper or parameters.yml — build with Task and config.yml as in the config.yml and build sections above.

Check out the OBS package​

export OBS_USER=your-username
export OBS_REPO=Devel:Galaxy:Manager:5.1

osc -A https://api.suse.de bco $OBS_REPO susemanager-docs_en

If this fails with a 404, log in at build.suse.de and try again.

Copy the English packages from uyuni-docs/build/packages/ into:

home:$OBS_USER:branches:$OBS_REPO/susemanager-docs_en

Update the spec and changelog​

cd home:$OBS_USER:branches:$OBS_REPO/susemanager-docs_en

In the .spec file, set Version: to the release version, for example:

Name:           susemanager-docs_en
Version: 5.1.x
Release: 0

Add the latest entries from uyuni-docs/.changelog with:

osc vc susemanager-docs_en.changes

Check in and submit​

osc ci -m "update"

The OBS build takes about 15 minutes. Check progress with osc pr.

When the packages build cleanly, create or supersede the service request:

osc sr -m "update"

Answer Supersede the old request? (y/n/c) as needed. Then tell @multi-linux-manager-releng on Slack (Vega or docs channels). The release manager accepts the SR so the docs land in the new RPMs.