dataops/.github/workflows/validate-planning-docs.yml at main · DataTalksClub/dataops · 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
name: Validate Planning Docs

on:
  push:
    branches:
      - main
    paths:
      - ".github/workflows/validate-planning-docs.yml"
      - "_docs/**"
      - "docs/**"
      - "templates/**"
      - "content/tasks/templates/**"
      - ".goal-v1.md"
      - "PROJECT_PLAN.md"
      - "PORTAL_ANALYSIS.md"
      - "README.md"
      - "scripts/validate_planning_docs.py"
      - "tools/content_tools/content_tools/doc_registry.py"
      - "tools/content_tools/content_tools/validate_docs_links.py"
      - "tools/content_tools/content_tools/validate_knowledge_repo.py"
      - "tests/planning_docs/**"
      - "tests/infra/**"
      - "infra/template.full.yaml"
      - "infra/template.github-actions-dataops.yaml"
      - "infra/template.github-actions.yaml"
      - ".github/workflows/deploy-dataops-v1.yml"
      - "backend/src/docs/sop/**"
      - "backend/scripts/sop.ts"
      - "Makefile"
  pull_request:
    paths:
      - ".github/workflows/validate-planning-docs.yml"
      - "_docs/**"
      - "docs/**"
      - "templates/**"
      - "content/tasks/templates/**"
      - ".goal-v1.md"
      - "PROJECT_PLAN.md"
      - "PORTAL_ANALYSIS.md"
      - "README.md"
      - "scripts/validate_planning_docs.py"
      - "tools/content_tools/content_tools/doc_registry.py"
      - "tools/content_tools/content_tools/validate_docs_links.py"
      - "tools/content_tools/content_tools/validate_knowledge_repo.py"
      - "tests/planning_docs/**"
      - "tests/infra/**"
      - "infra/template.full.yaml"
      - "infra/template.github-actions-dataops.yaml"
      - "infra/template.github-actions.yaml"
      - ".github/workflows/deploy-dataops-v1.yml"
      - "backend/src/docs/sop/**"
      - "backend/scripts/sop.ts"
      - "Makefile"
  workflow_dispatch:

permissions:
  contents: read

jobs:
  validate-planning-docs:
    name: Validate planning and process docs
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v6

      - name: Install uv
        uses: astral-sh/setup-uv@v8.1.0

      - name: Install Python
        run: uv python install

      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm

      - name: Install Node dependencies
        run: npm ci

      - name: Lint marked SOPs via Node CLI
        run: |
          files=$(grep -rl "schema_version: 1" content --include='*.md' | xargs grep -l "^doc_type: sop$" | tr '\n' ' ')
          if [ -z "$(echo "$files" | tr -d '[:space:]')" ]; then echo 'No marked SOP files found' >&2; exit 1; fi
          make sop-lint FILES="$files"

      - name: Run planning docs validation
        run: uv run --with pytest python -m pytest tests/planning_docs

      - name: Run infra template validation
        run: uv run --with pytest python -m pytest tests/infra

      - name: Validate dataops-knowledge migration scaffold
        run: uv run --project tools/content_tools python -m content_tools.validate_knowledge_repo --repo-root . --scaffold-root templates/dataops-knowledge

      - name: Validate docs links and workflow doc IDs
        run: uv run --project tools/content_tools python -m content_tools.validate_docs_links --repo-root . --content-root content