Skip to content

Move the Antora UI bundle to vshn/antora-ui v3.2.0 - #87

Open
arska wants to merge 1 commit into
masterfrom
antora-ui-bundle-v3
Open

arska wants to merge 1 commit into
masterfrom
antora-ui-bundle-v3

Conversation

@arska

@arska arska commented Nov 6, 2026

Copy link
Copy Markdown
Member

Summary

Moves the Antora UI bundle pin in docs/antora-playbook.yml from an antora-ui-default fork to vshn/antora-ui, where the four forks are being consolidated (vshn/antora-ui#176).

- https://github.com/vshn/antora-ui-default/releases/download/2.0.15/ui-bundle.zip
+ https://github.com/vshn/antora-ui/releases/download/v3.2.0/ui-bundle.zip
  • Bundle. v3.2.0 is the current release and publishes each brand as its own asset. snapshot goes to false: a pinned release never changes, so Antora need not download it again on every build.
  • Renovate rule. No built-in Renovate manager reads a URL inside a YAML value, so until now this pin was invisible and never moved. The custom manager is the one proven in vshn/appcat-user-docs (its PRs 273 and 290 were Renovate bumps across the 2.x to v3.x tag change). Patch bumps automerge once checks pass; minor and major bumps wait for a person, because the bundle changes how every page looks.
  • Docs build on pull requests. docs.yml only 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.yml runs make docs-html on pull requests that touch docs/, 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

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>
Copilot AI balanced review requested due to automatic review settings November 6, 2026 21:38
@arska arska added the documentation Improvements or additions to documentation label Nov 6, 2026
@arska arska self-assigned this Nov 6, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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.0 and 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

@arska

arska commented Nov 6, 2026

Copy link
Copy Markdown
Member Author

Docs build passes, so the v3.2.0 bundle downloads and builds. The red checks predate this PR, which changes no Go code:

  • go-lint has failed on every PR since at least 2026-10-13.
  • test-e2e (E2E) has failed on every branch push since at least 2026-10-13.
  • open-pr-component runs only when a PR is opened, checks out vshn/component-appcat without tags, and fails in hack/getversionlist.py with fatal: No names found, cannot describe anything. Renovate PRs skip that job.

@arska

arska commented Nov 7, 2026

Copy link
Copy Markdown
Member Author

The red go-lint, test-e2e and the open-pr-component golden step are fixed in PR 88, where lint and E2E pass. open-pr-component then fails pushing to component-appcat: COMPONENT_ACCESS_TOKEN is rejected and needs a valid token.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants