Skip to content

Commit 48ec34c

Browse files
authored
chore: Add Markdownlint to CI (#222)
- Turn off failing linter rules - Add problem matcher to show errors in CI results - Limit CI run to Markdown changes
1 parent dab8a2a commit 48ec34c

File tree

3 files changed

+71
-0
lines changed

3 files changed

+71
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"problemMatcher": [
3+
{
4+
"owner": "markdownlint",
5+
"pattern": [
6+
{
7+
"regexp": "^([^:]*):(\\d+):?(\\d+)?\\s([\\w-\\/]*)\\s(.*)$",
8+
"file": 1,
9+
"line": 2,
10+
"column": 3,
11+
"code": 4,
12+
"message": 5
13+
}
14+
]
15+
}
16+
]
17+
}

.github/workflows/markdownlint.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Markdownlint
2+
3+
on:
4+
push:
5+
paths:
6+
- "**/*.md"
7+
- ".markdownlint.json"
8+
- ".github/workflows/markdownlint.yml"
9+
- ".github/workflows/markdownlint-problem-matcher.json"
10+
pull_request:
11+
paths:
12+
- "**/*.md"
13+
- ".markdownlint.json"
14+
- ".github/workflows/markdownlint.yml"
15+
- ".github/workflows/markdownlint-problem-matcher.json"
16+
17+
jobs:
18+
lint:
19+
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- uses: actions/checkout@v2
24+
- name: Use Node.js
25+
uses: actions/setup-node@v1
26+
with:
27+
node-version: 12.x
28+
- name: Run Markdownlint
29+
run: |
30+
echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json"
31+
npm i -g markdownlint-cli
32+
markdownlint "**/*.md"

.markdownlint.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"default": true,
3+
"MD004": false,
4+
"MD007": false,
5+
"MD009": false,
6+
"MD010": false,
7+
"MD012": false,
8+
"MD013": false,
9+
"MD014": false,
10+
"MD022": false,
11+
"MD024": false,
12+
"MD025": false,
13+
"MD026": false,
14+
"MD029": false,
15+
"MD030": false,
16+
"MD032": false,
17+
"MD033": false,
18+
"MD034": false,
19+
"MD036": false,
20+
"MD040": false,
21+
"MD041": false
22+
}

0 commit comments

Comments
 (0)