Skip to content

Commit

Permalink
let's check for potential markdown issues (#104)
Browse files Browse the repository at this point in the history
**What this PR does / why we need it**:

We should make sure, that we don't have any broken links in our spec!
  • Loading branch information
hilmarf authored Mar 7, 2024
1 parent 8693d63 commit 1a184d3
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
13 changes: 13 additions & 0 deletions .github/.markdown-link-check.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "/github/workspace/"
}
],
"ignorePatterns": [
{
"pattern": "^http[s]*://localhost.*"
}
]
}
4 changes: 4 additions & 0 deletions .github/.markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
default: true

MD013: false #https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md013
MD033: false #https://github.com/DavidAnson/markdownlint/blob/HEAD/doc/Rules.md#md033
28 changes: 28 additions & 0 deletions .github/workflows/markdown-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: markdown-analysis-workflow

on:
push:
branches:
- main
pull_request:
branches:
- main
paths:
- '**/*.md'

jobs:
markdown-analysis-job:
runs-on: ubuntu-latest
name: 'github actions: markdownlint'
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: markdownlint
uses: nosborn/[email protected]
with:
files: .
config_file: ./.github/.markdownlint.yml
- name: markdown link check
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: ./.github/.markdown-link-check.json

0 comments on commit 1a184d3

Please sign in to comment.