Skip to content

Commit d1476d9

Browse files
committed
Add markdown action
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
1 parent e6bd19f commit d1476d9

3 files changed

Lines changed: 83 additions & 0 deletions

File tree

.github/markdownlin.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# From: https://github.com/openhab/openhab-docs/blob/main/.github/.markdownlint.yaml
2+
3+
default: true
4+
5+
# Expect dash usage for unorderd lists
6+
MD004:
7+
style: dash
8+
9+
# Allow long line lengths
10+
MD013: false
11+
12+
# Allow duplicate headers for different nesting
13+
MD024:
14+
siblings_only: true
15+
16+
# Allow Multiple top level headers in the same document
17+
MD025: false
18+
19+
# Allow trailing punctuation in headers
20+
MD026: false
21+
MD029:
22+
style: one
23+
24+
# Allow inline HTML
25+
MD033: false
26+
27+
# Code block style
28+
MD046:
29+
style: fenced
30+
31+
# Emphasiszis in underscore
32+
MD049:
33+
style: underscore
34+
35+
# Strong in asterisk
36+
MD050:
37+
style: asterisk

.github/mlc_config.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"ignorePatterns": [
3+
{ "pattern": "^https://github.com/openhab/openhab-addons/commit/.*" },
4+
{ "pattern": "^https://github.com/openhab/openhab-addons/pull/.*" },
5+
{ "pattern": "^mailto:.*" }
6+
]
7+
}

.github/workflows/markdownlint.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Check Markdown For Errors
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
markdownlint:
13+
name: markdownlint
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
19+
# pinning to SHA to mitigate possible supply chain attack
20+
- name: Run markdownlint-cli
21+
uses: nosborn/github-action-markdown-cli@508d6cefd8f0cc99eab5d2d4685b1d5f470042c1 # v3.5.0
22+
with:
23+
files: .
24+
config_file: ".github/markdownlint.yaml"
25+
26+
markdown-link-check:
27+
name: Broken Links Check
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout repository
31+
uses: actions/checkout@v4
32+
33+
# pinning to SHA to mitigate possible supply chain attack
34+
- name: Check for broken links
35+
uses: tcort/github-action-markdown-link-check@a800ad5f1c35bf61987946fd31c15726a1c9f2ba # v1.1.0
36+
with:
37+
use-quiet-mode: 'yes' # only show errors in output
38+
use-verbose-mode: 'yes' # show detailed HTTP status for checked links
39+
config-file: '.github/mlc_config.json'

0 commit comments

Comments
 (0)