Skip to content

Commit 555a331

Browse files
feat: add docs link check to CI/CD workflow and update documentation links to be relative
1 parent b3adbde commit 555a331

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

.github/workflows/ci-cd.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ jobs:
2828
# shellcheck → all .sh files at warning severity
2929
# actionlint → .github/workflows/
3030
# bats → tests/bats/ (env, scripts, kubernetes — offline)
31+
# docs-link-check → relative links in docs/ don't escape docs/
3132
shell-ci:
3233
uses: KevinDeBenedetti/github-workflows/.github/workflows/ci-shell.yml@main
3334
with:
@@ -39,6 +40,7 @@ jobs:
3940
bats-tests-dir: tests/bats/
4041
bats-submodules: false
4142
run-docker: false
43+
run-docs-link-check: true
4244

4345
# ─── Kubernetes validation + .env.example check ──────────────────────────
4446
kubernetes:

docs/using-with-infra.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ KUBECONFIG_CONTEXT=k3s-infra
168168

169169
> ⚠️ `.env` is in `.gitignore`. It is **never committed**. Add `.env.example` with placeholder values instead.
170170
171-
See the [Configuration reference](../configuration.md) for every variable.
171+
See the [Configuration reference](./configuration.md) for every variable.
172172

173173
---
174174

@@ -198,7 +198,7 @@ make deploy-grafana-secret
198198
make deploy-monitoring # Prometheus + Grafana + Loki + Promtail
199199
```
200200

201-
See [Getting Started](../getting-started.md) for the full step-by-step walkthrough.
201+
See [Getting Started](./getting-started.md) for the full step-by-step walkthrough.
202202

203203
---
204204

@@ -366,7 +366,7 @@ make vm-k3s-clean # tear down when done
366366

367367
The Lima targets read the same `.env` but override environment-specific values (`MASTER_IP=127.0.0.1`, self-signed TLS, NodePort instead of externalIPs).
368368

369-
See the [Local Testing guide](../operations/local-testing.md) for the complete walkthrough.
369+
See the [Local Testing guide](./operations/local-testing.md) for the complete walkthrough.
370370

371371
---
372372

prek.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ hooks = [
4646
{ id = "actionlint" },
4747
]
4848

49+
# ─── Docs link safety ────────────────────────────────────────────────────────
50+
[[repos]]
51+
repo = "https://github.com/KevinDeBenedetti/github-workflows"
52+
rev = "bfa0ca537a45e0d359ed3050005fe06a5ea11cbc"
53+
hooks = [
54+
{ id = "check-docs-links" },
55+
]
56+
4957
# ─── Local hooks ────────────────────────────────────────────────────────────
5058
[[repos]]
5159
repo = "local"

0 commit comments

Comments
 (0)