From 90db24ab2680120b51e7aaa5aae53871c7e07177 Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 14:45:57 +0530 Subject: [PATCH 1/6] Added workflow to validate links against each PR Signed-off-by: akashraj4261 --- .github/workflows/pr-link-validation.yml | 27 ++++++++++++++++++++++++ Makefile | 8 +++++++ 2 files changed, 35 insertions(+) create mode 100644 .github/workflows/pr-link-validation.yml diff --git a/.github/workflows/pr-link-validation.yml b/.github/workflows/pr-link-validation.yml new file mode 100644 index 000000000..b4ed0a187 --- /dev/null +++ b/.github/workflows/pr-link-validation.yml @@ -0,0 +1,27 @@ +name: "Docs: Antora Link Validation" + +on: + pull_request: + 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 \ No newline at end of file diff --git a/Makefile b/Makefile index 6920b6de5..ac4244a74 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,13 @@ .PHONY: all test +.PHONY: pr-link-check +ci-pr-link-check: + mkdir -p tmp + npx antora --version + npx antora --failure-level=warn --stacktrace --log-format=pretty --log-level=info \ + ss-local-playbook.yml \ + 2>&1 | tee tmp/ci-build.log + .PHONY: local local: mkdir -p tmp From 0ad3a6ca6be8d982f78b06229fca2a619bceb424 Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 15:03:30 +0530 Subject: [PATCH 2/6] Testing workflow Signed-off-by: akashraj4261 --- .github/workflows/pr-link-validation.yml | 5 ++++- docs/latest/modules/en/pages/test.adoc | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/latest/modules/en/pages/test.adoc diff --git a/.github/workflows/pr-link-validation.yml b/.github/workflows/pr-link-validation.yml index b4ed0a187..38c982cd0 100644 --- a/.github/workflows/pr-link-validation.yml +++ b/.github/workflows/pr-link-validation.yml @@ -2,7 +2,10 @@ name: "Docs: Antora Link Validation" on: pull_request: - paths: + branches: + - main + - staging + paths: - '**/*.adoc' - 'ss-local-playbook.yml' - 'Makefile' diff --git a/docs/latest/modules/en/pages/test.adoc b/docs/latest/modules/en/pages/test.adoc new file mode 100644 index 000000000..c93d4bb6a --- /dev/null +++ b/docs/latest/modules/en/pages/test.adoc @@ -0,0 +1,3 @@ +xref:suse-cloud-observability-quick-start-guide.adoc[this works] + +xref:installing-suse-obss.adoc[broken link] \ No newline at end of file From 0d252c7c64edcc2d4a4132584d897d992c444003 Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 15:06:53 +0530 Subject: [PATCH 3/6] Testing workflow-2 Signed-off-by: akashraj4261 --- docs/latest/modules/en/pages/test.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/latest/modules/en/pages/test.adoc b/docs/latest/modules/en/pages/test.adoc index c93d4bb6a..48161f49f 100644 --- a/docs/latest/modules/en/pages/test.adoc +++ b/docs/latest/modules/en/pages/test.adoc @@ -1,3 +1,3 @@ -xref:suse-cloud-observability-quick-start-guide.adoc[this works] +xref:installing-suse-obs.adoc[this works] xref:installing-suse-obss.adoc[broken link] \ No newline at end of file From 5ca4b8e5783b98c4e72830efc8a0e471713ddb77 Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 15:22:22 +0530 Subject: [PATCH 4/6] Testing workflow-3 Signed-off-by: akashraj4261 --- .github/workflows/pr-link-validation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-link-validation.yml b/.github/workflows/pr-link-validation.yml index 38c982cd0..719bcdfb7 100644 --- a/.github/workflows/pr-link-validation.yml +++ b/.github/workflows/pr-link-validation.yml @@ -5,7 +5,7 @@ on: branches: - main - staging - paths: + paths: - '**/*.adoc' - 'ss-local-playbook.yml' - 'Makefile' From dfa56e1a60e4f329d8d436ac57dd8661e9097533 Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 15:30:37 +0530 Subject: [PATCH 5/6] Testing workflow-4 Signed-off-by: akashraj4261 --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index ac4244a74..83914e0f5 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ .PHONY: all test .PHONY: pr-link-check -ci-pr-link-check: +pr-link-check: mkdir -p tmp npx antora --version npx antora --failure-level=warn --stacktrace --log-format=pretty --log-level=info \ From d52a6ab4d8ef0e44fa2b362ab9ebcae68a6f39df Mon Sep 17 00:00:00 2001 From: akashraj4261 Date: Fri, 3 Jul 2026 15:32:12 +0530 Subject: [PATCH 6/6] Testing workflow-5 Signed-off-by: akashraj4261 --- Makefile | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 83914e0f5..f46eeadcd 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,8 @@ pr-link-check: mkdir -p tmp npx antora --version - npx antora --failure-level=warn --stacktrace --log-format=pretty --log-level=info \ - ss-local-playbook.yml \ - 2>&1 | tee tmp/ci-build.log + npx antora --log-failure-level=warn --stacktrace --log-format=pretty --log-level=info \ + ss-local-playbook.yml .PHONY: local local: