CVE-Radar/.github/workflows/ci-docs.yml at main · zza-830/CVE-Radar · 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
47
48
49
50
51
52
53
54
# Category: CI | Extended-docs strict MkDocs build — six locales, glossary, API explorer.

name: CI / Docs

on:
  pull_request:
    branches: [main]
    paths: &docs-paths
      - "extended-docs/**"
      - "docs/**"
      - "agent/**"
      - ".github/workflows/ci-docs.yml"
      - ".github/workflows/deploy-pages.yml"
  push:
    branches: [main]
    paths: *docs-paths
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ci-docs-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  docs:
    name: Extended docs (MkDocs strict)
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

      - name: Setup Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: extended-docs/requirements.txt

      - name: Install MkDocs dependencies
        working-directory: extended-docs
        run: make install

      - name: Strict build
        working-directory: extended-docs
        env:
          DOCS_SITE_URL: ${{ vars.DOCS_SITE_URL || 'https://blog.raminnietzsche.ir/CVE-Radar/' }}
        run: make check

      - name: Verify Mermaid and zoom assets
        working-directory: extended-docs
        run: make verify