Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions .github/workflows/pr-link-validation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "Docs: Antora Link Validation"

on:
pull_request:
branches:
- main
- staging
paths:
- '**/*.adoc'
- 'ss-local-playbook.yml'
- 'Makefile'

jobs:
validate-internal-links:
name: Run Antora Build & Link Check
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20' # Matches standard modern Antora environments

- name: Install Dependencies
run: make environment

- name: Verify Documentation Links
run: make pr-link-check
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
.PHONY: all test

.PHONY: pr-link-check
pr-link-check:
mkdir -p tmp
npx antora --version
npx antora --log-failure-level=warn --stacktrace --log-format=pretty --log-level=info \
ss-local-playbook.yml

.PHONY: local
local:
mkdir -p tmp
Expand Down
3 changes: 3 additions & 0 deletions docs/latest/modules/en/pages/test.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
xref:installing-suse-obs.adoc[this works]

xref:installing-suse-obss.adoc[broken link]
Loading