Skip to content

README.md

Latest commit

 

History

History
106 lines (80 loc) · 3.92 KB

README.md

File metadata and controls

106 lines (80 loc) · 3.92 KB
Raw

Packages in pipe report generator

Generates an html report with the packages in the current tags.

Requirements

You'll need a few extra python modules:

  • koji
  • requests
  • specfile
  • pygithub

The user running the generator must have a working configuration for koji (in ~/.koji). A plane token with enough rights to list the cards in the XCPNG project must be passed either through the PLANE_TOKEN environment variable or the --plane-token command line option.

An extra --generated-info command line option may be used to add some info about the report generation process.

A machine readable version of the report can also be generated with the --json-output option:

pkg_in_pipe --json-output report.json report.html

The json report can be validated against its schema with:

python -m jsonschema -i report.json pkg_in_pipe.schema.json

Release post generator

The release_post.py script generates the whole XCP-ng release post from the json report. For each package of a given koji tag, it fetches the descriptions of the related pull requests from github and prints the Explain the change to users section of those descriptions.

It needs the pydantic, requests and tqdm python modules. An optional --github-token option (or GITHUB_TOKEN environment variable) is used to avoid the github api rate limits.

pkg_in_pipe --json-output report.json
release_post.py --report report.json

The release post is written on the standard output, as a full post template: the "What changed" section contains one item per package with the Explain the change to users section of the pull request descriptions, printed verbatim. The post writer can then reorganize the items into the usual categories. The "Versions" section lists every package of the tag with its version, showing the previously released version as well when the report knows it (the previous_nvr field, the newest build of the package in the updates or base tag). The --version option overrides the version number of the post, otherwise it is derived from the tag (e.g. v8.3-ci gives 8.3).

The verbatim version is printed as a single list item: a one line section is written right after the package name, a multiline section is written entirely on the following lines, indented under the package name (blank lines are preserved). The HTML comments left in the template of the pull request descriptions, and the blank lines around them, are removed. A package without that section still gets an entry, with an empty description, and a warning is printed on the standard error. For example:

- `xo-lite`: * Update the UiTitle component to use the one from web-core (PR #9869)

- `amd-microcode`:
    Update to 2026-05-19 drop as redistributed by XenServer
    Updated CPUs:
     BRH-C1 00b00f21: 2025-10-17, rev 0b002161 -> 2025-10-17, rev 0b002162

The pull request descriptions are cached (same cache as the report generator, in /tmp/pkg_in_pipe.cache, 24 hours retention). Use --cache to use another cache path and --re-cache to refresh the cache.

Run in docker

Before running in docker, the docker image must be built with:

docker build -t pkg_in_pipe .

A volume needs to be available to store the cache:

docker volume create pkg_in_pipe_cache

Several options are required to run the generator in docker:

  • a PLANE_TOKEN environment variable with the rights required to request all the cards in the XCPNG project;
  • a GITHUB_TOKEN environment variable with (at least) the public_repo scope;
  • a (read only) mount of a directory containing the requeried certificates to connect to koji in /root/.koji
  • a mount of the output directory in /output
  • the path of the generated report
docker run \
    -v ~/.koji:/root/.koji:z \
    -e PLANE_TOKEN=<plane token> \
    -e GITHUB_TOKEN=<github token> \
    -v /out/dir:/output:z \
    -v pkg_in_pipe_cache:/tmp/pkg_in_pipe.cache \
    pkg_in_pipe /output/index.html