Skip to content

Fix validate tasks to use Antora 3 built-in xref checking #5124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jcayouette wants to merge 2 commits into
base: manager-5.2
Choose a base branch
from
Draft

Fix validate tasks to use Antora 3 built-in xref checking #5124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8770fd
Fix validate tasks to use Antora 3 built-in xref checking
jcayouette Jul 17, 2026
6a5e7e7
Add changelog entry for Antora 3 validate task fix
jcayouette Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
- Fixed `task validate:mlm` and `task validate:uyuni` to use Antora 3 built-in xref
checking (`stage-content`, `gen-site`, `gen-antora`, `--log-failure-level=error`)
instead of the obsolete Antora 2.x `@antora/xref-validator` plugin, which was not
shipped in the builder image
- Documented Grafana reporting database automated setup and Hub Overview in Administration and Specialized Guides
- Update the OpenSCAP packages table in the
System Security with OpenSCAP article in the Administration guide (bsc#1269316)
Expand Down
24 changes: 16 additions & 8 deletions Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,21 +518,29 @@ tasks:
# --------------------------------------------------------------------------
validate:mlm:
desc: "[Local] Antora xref validation — MLM"
deps: [gen]
deps: [setup]
cmds:
- task: stage-content
- for: {var: LANGUAGES}
cmd: |
cd translations/{{.ITEM}}
NODE_PATH="$(npm -g root)" antora --generator @antora/xref-validator mlm-dsc.site.yml
echo "==> Validating mlm-dsc / {{.ITEM}}"
{{.DOCBUILD}} gen-site -product mlm -output mlm-dsc -lang {{.ITEM}}
{{.DOCBUILD}} gen-antora -product mlm -lang {{.ITEM}}
npx antora --log-failure-level=error --to-dir build/{{.ITEM}}/validate-mlm \
translations/{{.ITEM}}/mlm-dsc.site.yml

validate:uyuni:
desc: "[Local] Antora xref validation — Uyuni"
deps: [gen]
deps: [setup]
cmds:
- task: stage-content
- for: {var: LANGUAGES}
cmd: |
cd translations/{{.ITEM}}
NODE_PATH="$(npm -g root)" antora --generator @antora/xref-validator uyuni-website.site.yml
echo "==> Validating uyuni-website / {{.ITEM}}"
{{.DOCBUILD}} gen-site -product uyuni -output uyuni-website -lang {{.ITEM}}
{{.DOCBUILD}} gen-antora -product uyuni -lang {{.ITEM}}
npx antora --log-failure-level=error --to-dir build/{{.ITEM}}/validate-uyuni \
translations/{{.ITEM}}/uyuni-website.site.yml

# --------------------------------------------------------------------------
# Translations
Expand Down Expand Up @@ -693,12 +701,12 @@ tasks:
container:validate:mlm:
desc: "[Container] Antora xref validation — MLM"
cmds:
- "{{.CONTAINER_CMD}} run --rm -v {{.ROOT_DIR}}:/docs:Z -w /docs {{.BUILDER_IMAGE}} task validate:mlm"
- "{{.CONTAINER_CMD}} run --rm -v {{.ROOT_DIR}}:/docs:Z -w /docs {{.BUILDER_IMAGE}} task validate:mlm LANGUAGES='{{.LANGUAGES}}'"

container:validate:uyuni:
desc: "[Container] Antora xref validation — Uyuni"
cmds:
- "{{.CONTAINER_CMD}} run --rm -v {{.ROOT_DIR}}:/docs:Z -w /docs {{.BUILDER_IMAGE}} task validate:uyuni"
- "{{.CONTAINER_CMD}} run --rm -v {{.ROOT_DIR}}:/docs:Z -w /docs {{.BUILDER_IMAGE}} task validate:uyuni LANGUAGES='{{.LANGUAGES}}'"

# Translations
container:translations:
Expand Down