Skip to main content

Packaging Uyuni

Package the English Uyuni documentation after you 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. Update config.yml​

Set the Uyuni fields in config.yml before you build. At minimum:

  • products.uyuni.asciidoc.attributes.releaseversion / productnumber (quoted, for example "2026.08")
  • productchartversion and gitchartsbranch
  • antora.title (for example Uyuni 2026.08)
  • Supported client versions in the shared asciidoc: block. Confirm these with the release managers and the product owner.

Details: config.yml.

2. 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).

3. Update src.opensuse.org​

  1. Fork src.opensuse.org/uyuni/uyuni-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. Bump Version: in uyuni-docs_en.spec to the release you are packaging:
Name:           uyuni-docs_en
Version:        2026.08
Release:        0
  1. Format the changelog. The release number must be the topmost entry and must be bumped for every new release:
osc vc uyuni-docs_en.changes

Copy the latest entries from uyuni-docs/CHANGELOG.md under the timestamp. Do not use acronyms. Example:

-------------------------------------------------------------------
Wed Oct  7 09:16:07 UTC 2026 - FirstName LastName <user@suse.com>

- Version 2026.08
  * Updated client support matrix for the 2026.08 release
  * Documented container host requirements
  * Fixed installation procedure for the proxy
-------------------------------------------------------------------
  1. Commit and open a pull request against uyuni/uyuni-docs_en.

Then continue with Publish to uyuni-project.org.