Skip to content

Commit f604ef4

Browse files
committed
Run markdownlint via docker compose
1 parent 917b114 commit f604ef4

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/github-actions-templates.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- DO NOT EDIT THIS FILE!
22
3-
It was automatically created at 2025-05-05T10:20:02+02:00
3+
It was automatically created at 2025-05-06T10:12:47+02:00
44
by task/scripts/github-documentation-update
55
based on /app/task/scripts/../templates/github-actions-templates.md
66
-->
@@ -142,14 +142,20 @@ Validates styles files.
142142

143143
### Markdown
144144

145-
Uses [itkdev/markdownlint](https://hub.docker.com/r/itkdev/markdownlint) to
146-
link all Markdown files (`**/*.md`) in the project.
145+
Lints Markdown files (`**/*.md`) in the project.
147146

148147
[markdownlint-cli configuration
149148
files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
150149
`.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
151150
linted and how.
152151

152+
#### Assumptions
153+
154+
1. A docker compose service named `markdownlint` for running `markdownlint`
155+
(from
156+
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
157+
exists.
158+
153159
---
154160

155161
[github/workflows/symfony/php.yaml](github/workflows/symfony/php.yaml)

github/workflows/markdown.yaml

+9-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@
44

55
### ### Markdown
66
###
7-
### Uses [itkdev/markdownlint](https://hub.docker.com/r/itkdev/markdownlint) to
8-
### link all Markdown files (`**/*.md`) in the project.
7+
### Lints Markdown files (`**/*.md`) in the project.
98
###
109
### [markdownlint-cli configuration
1110
### files](https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration),
1211
### `.markdownlint.jsonc` and `.markdownlintignore`, control what is actually
1312
### linted and how.
13+
###
14+
### #### Assumptions
15+
###
16+
### 1. A docker compose service named `markdownlint` for running `markdownlint`
17+
### (from
18+
### [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli))
19+
### exists.
1420

1521
name: Markdown
1622

@@ -31,4 +37,4 @@ jobs:
3137
uses: actions/checkout@v4
3238

3339
- run: |
34-
docker run --rm --volume "$PWD":/md itkdev/markdownlint '**/*.md'
40+
docker compose run --rm markdownlint markdownlint '**/*.md'

0 commit comments

Comments
 (0)