Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(lint): Fixed 90-95% of Markdown lint violations across the repository #12587

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
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
  • Loading branch information
Brijeshthummar02 committed Feb 26, 2025
commit 9d03829b68e51cf28ef9e73589f826573dcf65ec
40 changes: 23 additions & 17 deletions .github/workflows/markdown-lint.yaml
Original file line number Diff line number Diff line change
@@ -3,34 +3,40 @@ name: Markdown Lint Check
on:
pull_request:
paths:
- '**/*.md'
- "**/*.md" # Run only when Markdown files change
push:
branches:
- main

permissions:
contents: read
pull-requests: write

jobs:
markdown-lint:
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'
- name: Install Node.js & Markdownlint
run: |
sudo apt-get update
sudo apt-get install -y markdownlint-cli
sudo apt-get install -y nodejs npm
sudo npm install -g markdownlint-cli
- name: Run Markdownlint Check
if: steps.check_changes.outputs.changed == 'true'
- name: Run Markdownlint
run: |
markdownlint '**/*.md' --config .markdownlint.json
markdownlint "**/*.md" --config .markdownlint.json > markdown-lint-report.txt || true
- name: Post Lint Report as PR Comment
if: github.event_name == 'pull_request'
uses: mshick/add-pr-comment@v2
with:
message: |
**Markdown Lint Report:**
```
$(cat markdown-lint-report.txt)
```
repo-token: ${{ secrets.GITHUB_TOKEN }}
allow-repeats: false
11 changes: 6 additions & 5 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -9,17 +9,17 @@
"style": "asterisk"
},
"extended-ascii": {
"ascii-only": true
"ascii-only": false
},
"fenced-code-language": {
"allowed_languages": [
"bash",
"go",
"html",
"javascript",
"json",
"markdown",
"text"
"text",
"go"
],
"language_only": true
},
@@ -30,7 +30,7 @@
"style": "---"
},
"line-length": {
"strict": true,
"strict": false,
"code_blocks": false
},
"link-image-style": {
@@ -42,7 +42,7 @@
"siblings_only": true
},
"ol-prefix": {
"style": "ordered"
"style": "any"
},
"proper-names": {
"code_blocks": false,
@@ -54,6 +54,7 @@
"markdown-it",
"markdownlint",
"Node.js",
"Docker",
"Go"
]
},
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
```