redhat-cop / redhat-cop/openshift-virtualization-migration-documentation

fix: pin Antora UI bundle to stable version — remove snapshot:true

Open Beginner friendly
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
2
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Problem

antora-playbook.yml configures the UI bundle with snapshot: true:

ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true

snapshot: true tells Antora to re-download the bundle on every build, always fetching the absolute latest CI artifact from the upstream Antora UI project. A breaking change in the upstream UI could silently break the documentation site without any change to this repository.

This issue is closely related to #2 (Update template to a Red Hat template). Once the Red Hat template is adopted, the bundle URL should be pinned to a specific tagged release.

Proposed Solution

  1. Resolve issue #2 first (adopt Red Hat branded Antora UI template)
  2. Pin the bundle URL to a specific stable/tagged release version
  3. Remove snapshot: true

If staying on the default Antora UI in the interim, replace the HEAD artifact URL with a pinned release URL, e.g.:

ui:
  bundle:
    url: https://github.com/antora/antora-ui-default/releases/download/v1.0.0/ui-bundle.zip

Files to Change

  • antora-playbook.yml

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading issue #2 and the UI bundle configuration in antora-playbook.yml, since the proposed Red Hat template affects which release should be pinned. Update the bundle URL to a specific stable or tagged artifact and remove snapshot: true. Done means the documentation build uses a fixed upstream bundle rather than fetching HEAD on every build.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
build-system, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.