Skip to content

Commit f3b57aa

Browse files
committed
🤖 Add GitHub Actions workflow for documentation quality
- Added automated markdown link checking - Added markdown linting for consistent formatting - Added spell checking with custom dictionary - Configured checks to run on push and PR - Helps maintain documentation quality automatically
1 parent 8519bbc commit f3b57aa

3 files changed

Lines changed: 89 additions & 0 deletions

File tree

.cspell.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"words": [
5+
"ACSC",
6+
"AppArmor",
7+
"AppLocker",
8+
"BYOD",
9+
"Gatekeeper",
10+
"Intune",
11+
"MFA",
12+
"SCCM",
13+
"SELinux",
14+
"WDAC",
15+
"WSUS",
16+
"ansible",
17+
"maturitylevel",
18+
"multifactor",
19+
"okta",
20+
"privacyIDEA",
21+
"roadmap",
22+
"tysoncung"
23+
],
24+
"ignorePaths": [
25+
"node_modules/**",
26+
".git/**",
27+
"*.log",
28+
"*.lock"
29+
]
30+
}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Documentation Check
2+
3+
on:
4+
push:
5+
branches: [ master, main ]
6+
pull_request:
7+
branches: [ master, main ]
8+
9+
jobs:
10+
markdown-link-check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Check Markdown links
16+
uses: gaurav-nelson/github-action-markdown-link-check@v1
17+
with:
18+
use-quiet-mode: 'yes'
19+
use-verbose-mode: 'no'
20+
config-file: '.markdown-link-check.json'
21+
22+
markdown-lint:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- uses: actions/checkout@v4
26+
27+
- name: Lint Markdown files
28+
uses: DavidAnson/markdownlint-cli2-action@v14
29+
with:
30+
globs: '**/*.md'
31+
32+
spell-check:
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/checkout@v4
36+
37+
- name: Check spelling
38+
uses: streetsidesoftware/cspell-action@v5
39+
with:
40+
files: '**/*.md'
41+
config: '.cspell.json'
42+
strict: false

.markdown-link-check.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^http://localhost"
5+
},
6+
{
7+
"pattern": "^https://localhost"
8+
}
9+
],
10+
"replacementPatterns": [],
11+
"httpHeaders": [],
12+
"timeout": "20s",
13+
"retryOn429": true,
14+
"retryCount": 3,
15+
"fallbackRetryDelay": "30s",
16+
"aliveStatusCodes": [200, 206, 301, 302, 303, 307, 308]
17+
}

0 commit comments

Comments
 (0)