Skip to content

Commit 9d03829

Browse files
Ensure prompt in console blocks follows Docker CLI standards
Signed-off-by: Brijeshthummar02 <brijeshthummar02@gmail.com> :wq Signed-off-by: Brijeshthummar02 <brijeshthummar02@gmail.com> :wq
1 parent 38867ef commit 9d03829

File tree

3 files changed

+31
-24
lines changed

3 files changed

+31
-24
lines changed

.github/workflows/markdown-lint.yaml

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,40 @@ name: Markdown Lint Check
33
on:
44
pull_request:
55
paths:
6-
- '**/*.md'
6+
- "**/*.md" # Run only when Markdown files change
77
push:
88
branches:
99
- main
1010

11+
permissions:
12+
contents: read
13+
pull-requests: write
14+
1115
jobs:
1216
markdown-lint:
1317
runs-on: ubuntu-latest
1418
steps:
15-
- name: Checkout Code
19+
- name: Checkout Repository
1620
uses: actions/checkout@v4
1721

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-
- name: Install Markdownlint
28-
if: steps.check_changes.outputs.changed == 'true'
22+
- name: Install Node.js & Markdownlint
2923
run: |
3024
sudo apt-get update
31-
sudo apt-get install -y markdownlint-cli
25+
sudo apt-get install -y nodejs npm
26+
sudo npm install -g markdownlint-cli
3227
33-
- name: Run Markdownlint Check
34-
if: steps.check_changes.outputs.changed == 'true'
28+
- name: Run Markdownlint
3529
run: |
36-
markdownlint '**/*.md' --config .markdownlint.json
30+
markdownlint "**/*.md" --config .markdownlint.json > markdown-lint-report.txt || true
31+
32+
- name: Post Lint Report as PR Comment
33+
if: github.event_name == 'pull_request'
34+
uses: mshick/add-pr-comment@v2
35+
with:
36+
message: |
37+
**Markdown Lint Report:**
38+
```
39+
$(cat markdown-lint-report.txt)
40+
```
41+
repo-token: ${{ secrets.GITHUB_TOKEN }}
42+
allow-repeats: false

.markdownlint.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@
99
"style": "asterisk"
1010
},
1111
"extended-ascii": {
12-
"ascii-only": true
12+
"ascii-only": false
1313
},
1414
"fenced-code-language": {
1515
"allowed_languages": [
1616
"bash",
17-
"go",
1817
"html",
1918
"javascript",
2019
"json",
2120
"markdown",
22-
"text"
21+
"text",
22+
"go"
2323
],
2424
"language_only": true
2525
},
@@ -30,7 +30,7 @@
3030
"style": "---"
3131
},
3232
"line-length": {
33-
"strict": true,
33+
"strict": false,
3434
"code_blocks": false
3535
},
3636
"link-image-style": {
@@ -42,7 +42,7 @@
4242
"siblings_only": true
4343
},
4444
"ol-prefix": {
45-
"style": "ordered"
45+
"style": "any"
4646
},
4747
"proper-names": {
4848
"code_blocks": false,
@@ -54,6 +54,7 @@
5454
"markdown-it",
5555
"markdownlint",
5656
"Node.js",
57+
"Docker",
5758
"Go"
5859
]
5960
},

docs/reference/compose_kill.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
55

66
```console
7-
docker compose kill -s SIGINT
7+
$ docker compose kill -s SIGINT
88
```
99

1010
### Options
@@ -22,5 +22,5 @@ docker compose kill -s SIGINT
2222
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
2323

2424
```console
25-
docker compose kill -s SIGINT
25+
$ docker compose kill -s SIGINT
2626
```

0 commit comments

Comments
 (0)