prega-release-notes

prega-release-notes

Standalone tooling to generate Markdown release notes for a subset of OLM packages from a single catalog index image: opm render → resolve head bundles on the default channel → oc image extract → read ClusterServiceVersion manifests. The CLI accepts NDJSON or formatted JSON from opm (no jq pipeline). If oc image extract --path /manifests:. yields no CSV, it retries with a full image root extract and discovers the CSV under the tree. Optional --include-github-prs adds the operator’s GitHub repo (from CSV annotations) and recent merged PRs for manual correlation with bundle version and OCI image lines.

[!CAUTION] Unless specified otherwise, everything contained in this repository is unsupported by Red Hat.

Use it. Break it. Improve it.

Demo video

▶ Watch on YouTube — GitHub’s README renderer does not support embedded iframes or autoplay; the image above is a standard click-to-play thumbnail that opens the video on YouTube (where playback and autoplay follow YouTube’s own rules).

Setup

cd prega-release-notes   # this directory
pip install -r requirements.txt
chmod +x bin/prega-release-notes scripts/bootstrap_clients.py

OpenShift clients (oc, opm)

• Already on your machine: ensure they are on PATH, or place them under bin/.
• Auto-download (official mirror): either run python3 scripts/bootstrap_clients.py (or ./scripts/bootstrap_clients.py if executable) with OCP_VERSION matching your index (e.g. 4.20 or 4.22.0-ec.0 for dev-preview), or pass --auto-install-clients to ./bin/prega-release-notes so missing oc/opm are installed into bin/ before the run. Optional: PREG_RELEASE_NOTES_AUTO_INSTALL_CLIENTS=1. Tune the channel with --ocp-version or env OCP_VERSION.

Broader installs (Helm, ROSA, checksum-first workflows) are documented in .cursor/skills/openshift-client-download/SKILL.md, aligned with ai-helpers@b0e2950.

Downloaded CLIs under bin/ are listed in .gitignore (keep bin/prega-release-notes in git).

Registry auth

DOCKER_CONFIG (directory containing config.json), REGISTRY_AUTH_FILE, or --authfile.

Usage

export DOCKER_CONFIG=/path/to/auth-dir
export PATH="$PWD/bin:$PATH"   # if using bootstrap / --auto-install-clients
./bin/prega-release-notes --auto-install-clients --ocp-version 4.20 \
  --index quay.io/prega/prega-operator-index:v4.22.0-ec.0 \
  --packages ocs-operator metallb-operator \
  -o subset-release-notes.md

See ./bin/prega-release-notes --help for --opm-timeout, --rendered-json, and other options.

GitHub merged PRs (optional)

• --include-github-prs — fetch recent merged PRs for the first github.com repo URL found in CSV metadata (common keys: repository, operators.operatorframework.io/repository, source, or any annotation value containing github.com).
• --github-pr-limit N — default 20; only applies with --include-github-prs.
• GITHUB_TOKEN or --github-token — recommended for API rate limits and private forks.

PR lists are heuristic (newest merges first); tie them to the shipped bundle using CSV version, containerImage, and relatedImages in the same section of the generated notes.

For each merged PR, the tool adds a short Change line (first paragraph of the PR body when present) and Jira / references lines: keys like OCPBUGS-83413 or https://redhat.atlassian.net/browse/… / issues.redhat.com/browse/… in the title or body are turned into canonical links https://redhat.atlassian.net/browse/<KEY>, plus a deduplicated list at the end of the PR section.

Tests

pip install -r requirements.txt
python3 -m unittest tests.test_release_notes_subset -v

Claude Code marketplace (install via /plugin)

This repo ships a plugin marketplace at .claude-plugin/marketplace.json (see Claude Code: Create and distribute a plugin marketplace).

1. Add the marketplace (GitHub shorthand; uses the default branch):

   claude plugin marketplace add midu16/prega-release-notes
   

   Or in the Claude Code UI: register the Git repo so the checkout contains .claude-plugin/marketplace.json at the repository root (that path is what Claude resolves; the earlier “marketplace file not found” error means that file was missing or the URL pointed at the wrong tree).