documentation/.github/workflows/markdown.yaml at main · AarhusAI/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
### ### Markdown
###
### 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

on:
  pull_request:
  push:
    branches:
      - main
      - develop

jobs:
  markdown-lint:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Create docker network
        run: |
          docker network create frontend

      - run: |
          docker compose run --rm markdownlint markdownlint '**/*.md'