Skip to content

Commit

Permalink
Ensure prompt in console blocks follows Docker CLI standards
Browse files Browse the repository at this point in the history
Signed-off-by: Brijeshthummar02 <brijeshthummar02@gmail.com>

:wq
  • Loading branch information
Brijeshthummar02 committed Feb 26, 2025
1 parent 38867ef commit 8f5e445
Showing 3 changed files with 20 additions and 56 deletions.
29 changes: 12 additions & 17 deletions .github/workflows/markdown-lint.yaml
Original file line number Diff line number Diff line change
@@ -3,34 +3,29 @@ name: Markdown Lint Check
on:
pull_request:
paths:
- '**/*.md'
push:
branches:
- main
- "**/*.md"

jobs:
markdown-lint:
name: Markdown Lint Check
runs-on: ubuntu-latest

steps:
- name: Checkout Code
- name: Checkout Repository
uses: actions/checkout@v4

- name: Check if Markdown Files Changed
id: check_changes
run: |
if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E '\.md$'; then
echo "changed=true" >> $GITHUB_OUTPUT
else
echo "changed=false" >> $GITHUB_OUTPUT
fi
- name: Install Markdownlint
if: steps.check_changes.outputs.changed == 'true'
run: |
sudo apt-get update
sudo apt-get install -y markdownlint-cli
- name: Run Markdownlint Check
if: steps.check_changes.outputs.changed == 'true'
run: |
markdownlint '**/*.md' --config .markdownlint.json
markdownlint '**/*.md' --config .markdownlint.json || echo "::warning file=.md::Markdown lint issues found"
- name: Post Review Comments (Optional)
if: failure()
uses: thollander/actions-comment-pull-request@v2
with:
message: "⚠️ Markdown linting found issues! Please review and fix."
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43 changes: 6 additions & 37 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -6,20 +6,18 @@
"style": "backtick"
},
"emphasis-style": {
"style": "asterisk"
},
"extended-ascii": {
"ascii-only": true
"style": "underscore"
},
"extended-ascii": false,
"fenced-code-language": {
"allowed_languages": [
"bash",
"go",
"html",
"javascript",
"json",
"markdown",
"text"
"text",
"go"
],
"language_only": true
},
@@ -29,40 +27,11 @@
"hr-style": {
"style": "---"
},
"line-length": {
"strict": true,
"code_blocks": false
},
"link-image-style": {
"collapsed": false,
"shortcut": false,
"url_inline": false
},
"line-length": false,
"ol-prefix": false,
"no-duplicate-heading": {
"siblings_only": true
},
"ol-prefix": {
"style": "ordered"
},
"proper-names": {
"code_blocks": false,
"names": [
"Cake.Markdownlint",
"CommonMark",
"JavaScript",
"Markdown",
"markdown-it",
"markdownlint",
"Node.js",
"Go"
]
},
"reference-links-images": {
"shortcut_syntax": true
},
"strong-style": {
"style": "asterisk"
},
"ul-style": {
"style": "dash"
}
4 changes: 2 additions & 2 deletions docs/reference/compose_kill.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:

```console
docker compose kill -s SIGINT
$ docker compose kill -s SIGINT
```

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

```console
docker compose kill -s SIGINT
$ docker compose kill -s SIGINT
```

0 comments on commit 8f5e445

Please sign in to comment.