Run markdownlint via docker compose

Author: rimi-itk

.github/workflows/markdown.yaml

@@ -2,19 +2,30 @@
 # github/workflows/markdown.yaml in
 # https://github.com/itk-dev/devops_itkdev-docker if need be.
 
-### ## Markdown
+### ### Markdown
 ###
-### Uses [itkdev/markdownlint](https://hub.docker.com/r/itkdev/markdownlint) to
-### link all Markdown files (`**/*.md`) in the project.
+### Lints Markdown files (`**/*.md`) in the project.
 ###
-### [markdownlint-cli configuration ### files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
-### `.markdownlint.jsonc` and `.markdownlintignore` control what is actually linted and how.
+### [markdownlint-cli configuration
+### files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
+### `.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
+### linted and how.
+###
+### #### Assumptions
+###
+### 1. A docker compose service named `markdownlint` for running `markdownlint`
+###    (from
+###    [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
+###    exists.
 
 name: Markdown
 
 on:
   pull_request:
   push:
+    branches:
+      - main
+      - develop
 
 jobs:
   markdown-lint:
@@ -26,4 +37,7 @@ jobs:
         uses: actions/checkout@v4
 
       - run: |
-          docker run --rm --volume "$PWD":/md itkdev/markdownlint '**/*.md'
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm markdownlint markdownlint '**/*.md'

compose.yaml

@@ -0,0 +1,7 @@
+services:
+  markdownlint:
+    image: itkdev/markdownlint
+    profiles:
+      - dev
+    volumes:
+      - ./:/md

docs/github-actions-templates.md

@@ -1,6 +1,6 @@
 <!-- DO NOT EDIT THIS FILE!
 
-It was automatically created at 2025-05-05T10:20:02+02:00
+It was automatically created at 2025-05-06T10:12:47+02:00
 by task/scripts/github-documentation-update
 based on /app/task/scripts/../templates/github-actions-templates.md
 -->
@@ -142,14 +142,20 @@ Validates styles files.
 
 ### Markdown
 
-Uses [itkdev/markdownlint](https://hub.docker.com/r/itkdev/markdownlint) to
-link all Markdown files (`**/*.md`) in the project.
+Lints Markdown files (`**/*.md`) in the project.
 
 [markdownlint-cli configuration
 files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
 `.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
 linted and how.
 
+#### Assumptions
+
+1. A docker compose service named `markdownlint` for running `markdownlint`
+   (from
+   [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
+   exists.
+
 ---
 
 [github/workflows/symfony/php.yaml](github/workflows/symfony/php.yaml)

github/workflows/markdown.yaml

@@ -4,13 +4,19 @@
 
 ### ### Markdown
 ###
-### Uses [itkdev/markdownlint](https://hub.docker.com/r/itkdev/markdownlint) to
-### link all Markdown files (`**/*.md`) in the project.
+### Lints Markdown files (`**/*.md`) in the project.
 ###
 ### [markdownlint-cli configuration
 ### files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
 ### `.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
 ### linted and how.
+###
+### #### Assumptions
+###
+### 1. A docker compose service named `markdownlint` for running `markdownlint`
+###    (from
+###    [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
+###    exists.
 
 name: Markdown
 
@@ -31,4 +37,7 @@ jobs:
         uses: actions/checkout@v4
 
       - run: |
-          docker run --rm --volume "$PWD":/md itkdev/markdownlint '**/*.md'
+          docker network create frontend
+
+      - run: |
+          docker compose run --rm markdownlint markdownlint '**/*.md'