CA-Project/.github/workflows/docs.yml at main · DeepakChander/CA-Project · 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
41
42
43
44
45
46
name: Docs CI

on:
  pull_request:
    paths:
      - "docs/**"
      - "README.md"
      - ".github/workflows/docs.yml"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "README.md"

permissions:
  contents: read
  pull-requests: write

jobs:
  markdown-lint:
    name: Markdown lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install markdownlint-cli2
        run: npm i -g markdownlint-cli2@0.13.0

      - name: Run markdownlint
        run: markdownlint-cli2 "docs/**/*.md" "README.md"
        continue-on-error: true # advisory until ruleset is tuned

  link-check:
    name: Link check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: lycheeverse/lychee-action@v2
        with:
          args: --no-progress --max-concurrency 4 --exclude-mail "docs/**/*.md" "README.md"
          fail: false # report-only initially