GeneralizedNotationNotation/.github/workflows/docs-audit.yml at main · ActiveInferenceInstitute/GeneralizedNotationNotation · 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
55
56
57
58
59
60
61
62
63
64
65
name: Docs audit

# Main CI skips markdown paths; this workflow keeps link + AGENTS/README parity checks on doc changes.

on:
  push:
    branches: [main]
    paths:
      - "**/*.md"
      - "doc/**"
      - "AGENTS.md"
      - "CLAUDE.md"
      - "README.md"
      - "SKILL.md"
      - "doc/development/docs_audit.py"
  pull_request:
    branches: [main]
    paths:
      - "**/*.md"
      - "doc/**"
      - "AGENTS.md"
      - "CLAUDE.md"
      - "README.md"
      - "SKILL.md"
      - "doc/development/docs_audit.py"
  workflow_dispatch:

concurrency:
  group: docs-audit-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  markdown-audit:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.12"

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - name: Install dependencies (dev)
        run: uv sync --frozen --extra dev

      - name: Documentation audit (strict)
        run: uv run --extra dev python doc/development/docs_audit.py --strict --check-anchors --no-write

      - name: Repository terminology audit
        run: uv run --extra dev python scripts/check_repo_terminology.py --strict

      - name: Maintained documentation terminology audit
        run: uv run --extra dev python scripts/check_maintained_doc_terms.py --strict

      - name: GNN documentation pattern audit
        run: uv run --extra dev python scripts/check_gnn_doc_patterns.py --strict