add automatic link + markdown checking

OWASP · Sep 5, 2024 · e4997de · e4997de
1 parent cfdc88b
commit e4997de
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,48 @@
+name: CI pipeline
+on:
+  push:
+    branches:
+      - main
+      - master
+  workflow_dispatch:
+
+# for security reasons the github actions are pinned to specific release versions
+jobs:
+  link_checker:
+    name: Link checker
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout markdown
+        uses: actions/checkout@v4.1.1
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.10.0
+        with:
+          # skip the jekyll files
+          args: --no-progress --max-retries 5 './docs/**/*.md' '*.md'
+          fail: false
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+  md_linter:
+    name: Lint markdown
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout markdown
+        uses: actions/checkout@v4.1.1
+
+      - name: Lint markdown
+        uses: DavidAnson/markdownlint-cli2-action@v16.0.0
+        with:
+          config: '.markdownlint.yaml'
+          globs: './docs/**/*.md'
+
+  spell_checker:
+    name: Check spelling
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout markdown
+        uses: actions/checkout@v4.1.1
+
+      - name: spell_checker
+        uses: rojopolis/spellcheck-github-actions@0.41.0
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,16 @@
+---
+no-trailing-punctuation: false
+no-inline-html: false
+first-line-heading: false
+link-fragments: false
+
+# MD013 - Line length
+MD013:
+  code_block_line_length: 125
+  code_blocks: true
+  heading_line_length: 80
+  headings: true
+  line_length: 125
+  stern: true
+  strict: false
+  tables: true