Packaging Uyuni
Package the English Uyuni documentation from a maintenance branch. Update config.yml and run task container:obs:uyuni. Submit the packages only to src.opensuse.org/uyuni/uyuni-docs_en: fork the repo and open a pull request.
Do not submit Uyuni docs packages to build.opensuse.org.
osc is used only to format the changelog (osc vc). Configuring an OBS account is out of scope for this page.
For setup, see Container setup.
1. Create the maintenance branch
Create the maintenance branch from master before you change config.yml. Name it uyuni-YYYY.MM, for example uyuni-2026.10.
cd uyuni-docs
git checkout master
git pull --ff-only origin master
git checkout -b uyuni-2026.10
git push --set-upstream origin uyuni-2026.10
Replace 2026.10 with the maintenance version you are releasing. Do the rest of this page on that branch.
2. Update config.yml
On the maintenance branch, set the Uyuni fields in config.yml before you build. Field reference: config.yml.
Under products.uyuni:
| Field | What to set |
|---|---|
antora.title | Antora component title, for example Uyuni 2026.08 |
Under products.uyuni.asciidoc.attributes:
| Field | What to set |
|---|---|
releaseversion / productnumber | Release label, quoted so it is kept as written (for example "2026.08") |
productchartversion | Helm chart version for this release |
gitchartsbranch | Charts branch for this release |
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 packages
cd uyuni-docs
task container:build # once, or after Dockerfile.bci changes
task container:obs:uyuni LANGUAGES=en
English packages land in build/packages/ on the host (uyuni-docs_en.tar.gz and uyuni-docs_en-pdf.tar.gz).
4. Update src.opensuse.org
- Fork src.opensuse.org/uyuni/uyuni-docs_en and clone your fork.
- Copy the English packages from
uyuni-docs/build/packages/into the package directory in your fork. Ship the en build only. - Bump
Version:inuyuni-docs_en.specto the release you are packaging:
Name: uyuni-docs_en
Version: 2026.08
Release: 0
-
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 uyuni-docs_en.changesUnder the header, add the entries from
uyuni-docs/.changelog. The release number must be the topmost entry and must be bumped for every new release. The entry must match the existinguyuni-docs_en.changessyntax: a* Versionline, then-bullets. Indent wrapped lines, and put a Bugzilla reference at the end of a bullet when you have one.-------------------------------------------------------------------
Wed Oct 7 09:16:07 UTC 2026 - Your Name <your.name@suse.com>
* Version 2026.08
- Updated the client support matrix for the 2026.08
release
- Documented container host requirements
- Fixed the installation procedure for the proxy
(bsc#1234567) -
Commit and open a pull request against uyuni/uyuni-docs_en.
Then continue with Publish to uyuni-project.org.