Repository navigation
Conversation
The four antora-ui-default forks are being consolidated into vshn/antora-ui, which publishes every brand as its own release asset. Point the playbook at ui-bundle.zip there and stop re-downloading a pinned release on every build (snapshot: false). Add a Renovate custom manager for the bundle URL, which no built-in manager can read. Patch releases automerge once checks pass; minor and major releases wait for review, because they change how every page looks. Build the docs on pull requests that touch docs/, so a broken bundle URL fails the PR instead of the next publish. Part of vshn/antora-ui#204. Signed-off-by: Aarno Aukia <aarno.aukia@vshn.ch> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🔵 Needs a closer look
The site-wide UI bundle upgrade requires human review of a rendered local preview to validate appearance and navigation, which build success and static inspection cannot confirm.
No open issues 🎉
What changed in this PR
Migrates the documentation UI to the consolidated vshn/antora-ui release and adds automated dependency updates and pull-request build validation.
Changes:
- Pins the UI bundle to
v3.2.0and disables snapshot downloads. - Adds Renovate tracking, with patch automerge enabled and manual review for minor and major updates.
- Adds a non-publishing documentation build for pull requests touching docs or the build workflow.
| File | Description |
|---|---|
renovate.json |
Tracks UI bundle releases and configures update-specific automerge rules. |
docs/antora-playbook.yml |
Switches to the consolidated UI bundle at v3.2.0 with snapshots disabled. |
.github/workflows/docs-build.yml |
Runs make docs-html on relevant pull requests without publishing. |
Review effort: Balanced
|
|
|
The red |
Summary
Moves the Antora UI bundle pin in
docs/antora-playbook.ymlfrom anantora-ui-defaultfork tovshn/antora-ui, where the four forks are being consolidated (vshn/antora-ui#176).v3.2.0is the current release and publishes each brand as its own asset.snapshotgoes tofalse: a pinned release never changes, so Antora need not download it again on every build.vshn/appcat-user-docs(its PRs 273 and 290 were Renovate bumps across the2.xtov3.xtag change). Patch bumps automerge once checks pass; minor and major bumps wait for a person, because the bundle changes how every page looks.docs.ymlonly runs on pushes and tags and publishes to GitHub Pages, so until now the first build of a docs change was its publish.docs-build.ymlrunsmake docs-htmlon pull requests that touchdocs/, publishes nothing, and is what lets a Renovate patch bump merge on its own safely. It runs on this PR, which is the check that the new bundle builds.The jump from the old pin is large, so the rendered docs will look different. Please look at a local build (
make docs-html, output in.public/) before merging.Part of vshn/antora-ui#204.
🤖 Generated with Claude Code