Merge pull request #309 from dklimpel/doc_gitlab_ci

docs: add example for GitLab pipeline
tcort · May 21, 2024 · 0938a98 · 0938a98
2 parents 7e9668f + dd27b9a
commit 0938a98
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -50,6 +50,21 @@ To run as a [pre-commit hook](https://pre-commit.com):
       args: [-q]
 ```
 
+## Run in a GitLab pipeline
+
+```yaml
+linkchecker:
+  stage: test
+  image:
+    name: ghcr.io/tcort/markdown-link-check:3.11.2
+    entrypoint: ["/bin/sh", "-c"]
+  script:
+    - find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
+  rules:
+    - changes:
+      - "**/*.md"
+```
+
 ## Run in other tools
 
 - [Mega-Linter](https://megalinter.io/latest/): Linters aggregator [including markdown-link-check](https://megalinter.io/latest/descriptors/markdown_markdown_link_check/)