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
docker · Feb 26, 2025 · 9d03829 · 9d03829
1 parent 38867ef
commit 9d03829
Showing 3 changed files with 31 additions and 24 deletions.
diff --git a/.github/workflows/markdown-lint.yaml b/.github/workflows/markdown-lint.yaml
@@ -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
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -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"
     ]
   },

diff --git a/docs/reference/compose_kill.md b/docs/reference/compose_kill.md
@@ -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
 ```