File tree Expand file tree Collapse file tree 3 files changed +20
-56
lines changed Expand file tree Collapse file tree 3 files changed +20
-56
lines changed Original file line number Diff line number Diff line change @@ -3,34 +3,29 @@ name: Markdown Lint Check
3
3
on :
4
4
pull_request :
5
5
paths :
6
- - ' **/*.md'
7
- push :
8
- branches :
9
- - main
6
+ - " **/*.md"
10
7
11
8
jobs :
12
9
markdown-lint :
10
+ name : Markdown Lint Check
13
11
runs-on : ubuntu-latest
12
+
14
13
steps :
15
- - name : Checkout Code
14
+ - name : Checkout Repository
16
15
uses : actions/checkout@v4
17
16
18
- - name : Check if Markdown Files Changed
19
- id : check_changes
20
- run : |
21
- if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E '\.md$'; then
22
- echo "changed=true" >> $GITHUB_OUTPUT
23
- else
24
- echo "changed=false" >> $GITHUB_OUTPUT
25
- fi
26
-
27
17
- name : Install Markdownlint
28
- if : steps.check_changes.outputs.changed == 'true'
29
18
run : |
30
19
sudo apt-get update
31
20
sudo apt-get install -y markdownlint-cli
32
21
33
22
- name : Run Markdownlint Check
34
- if : steps.check_changes.outputs.changed == 'true'
35
23
run : |
36
- markdownlint '**/*.md' --config .markdownlint.json
24
+ markdownlint '**/*.md' --config .markdownlint.json || echo "::warning file=.md::Markdown lint issues found"
25
+
26
+ - name : Post Review Comments (Optional)
27
+ if : failure()
28
+ uses : thollander/actions-comment-pull-request@v2
29
+ with :
30
+ message : " ⚠️ Markdown linting found issues! Please review and fix."
31
+ GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
Original file line number Diff line number Diff line change 6
6
"style" : " backtick"
7
7
},
8
8
"emphasis-style" : {
9
- "style" : " asterisk"
10
- },
11
- "extended-ascii" : {
12
- "ascii-only" : true
9
+ "style" : " underscore"
13
10
},
11
+ "extended-ascii" : false ,
14
12
"fenced-code-language" : {
15
13
"allowed_languages" : [
16
14
" bash" ,
17
- " go" ,
18
15
" html" ,
19
16
" javascript" ,
20
17
" json" ,
21
18
" markdown" ,
22
- " text"
19
+ " text" ,
20
+ " go"
23
21
],
24
22
"language_only" : true
25
23
},
29
27
"hr-style" : {
30
28
"style" : " ---"
31
29
},
32
- "line-length" : {
33
- "strict" : true ,
34
- "code_blocks" : false
35
- },
36
- "link-image-style" : {
37
- "collapsed" : false ,
38
- "shortcut" : false ,
39
- "url_inline" : false
40
- },
30
+ "line-length" : false ,
31
+ "ol-prefix" : false ,
41
32
"no-duplicate-heading" : {
42
33
"siblings_only" : true
43
34
},
44
- "ol-prefix" : {
45
- "style" : " ordered"
46
- },
47
- "proper-names" : {
48
- "code_blocks" : false ,
49
- "names" : [
50
- " Cake.Markdownlint" ,
51
- " CommonMark" ,
52
- " JavaScript" ,
53
- " Markdown" ,
54
- " markdown-it" ,
55
- " markdownlint" ,
56
- " Node.js" ,
57
- " Go"
58
- ]
59
- },
60
- "reference-links-images" : {
61
- "shortcut_syntax" : true
62
- },
63
- "strong-style" : {
64
- "style" : " asterisk"
65
- },
66
35
"ul-style" : {
67
36
"style" : " dash"
68
37
}
Original file line number Diff line number Diff line change 4
4
Forces running containers to stop by sending a ` SIGKILL ` signal. Optionally the signal can be passed, for example:
5
5
6
6
``` console
7
- docker compose kill -s SIGINT
7
+ $ docker compose kill -s SIGINT
8
8
```
9
9
10
10
### Options
@@ -22,5 +22,5 @@ docker compose kill -s SIGINT
22
22
Forces running containers to stop by sending a ` SIGKILL ` signal. Optionally the signal can be passed, for example:
23
23
24
24
``` console
25
- docker compose kill -s SIGINT
25
+ $ docker compose kill -s SIGINT
26
26
```
You can’t perform that action at this time.
0 commit comments