chore: add markdown lint checks

open-telemetry · Dec 8, 2021 · 938ffb7 · 938ffb7
1 parent 09d3f68
commit 938ffb7
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/.github/workflows/markdown-lint.config.json b/.github/workflows/markdown-lint.config.json
@@ -0,0 +1,3 @@
+{
+  "retryOn429": true
+}
diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml
@@ -0,0 +1,19 @@
+name: Markdown Linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      # checks all markdown including all subfolders
+      with:
+        use-quiet-mode: 'yes'
+        use-verbose-mode: 'yes'
+        config-file: '.github/workflows/markdown-lint.config.json'