dataops/.github/workflows/validate-dataops-content.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
name: Validate DataOps Content

on:
  push:
    branches:
      - main
    paths:
      - "content/**"
      - "docs/**"
      - ".goal-v1.md"
      - "PROJECT_PLAN.md"
      - "PORTAL_ANALYSIS.md"
      - "README.md"
      - "backend/scripts/seed-templates.ts"
      - "tools/content_tools/**"
      - ".github/workflows/validate-dataops-content.yml"
  pull_request:
    paths:
      - "content/**"
      - ".goal-v1.md"
      - "PROJECT_PLAN.md"
      - "PORTAL_ANALYSIS.md"
      - "README.md"
      - "backend/scripts/seed-templates.ts"
      - "tools/content_tools/**"
      - ".github/workflows/validate-dataops-content.yml"
  workflow_dispatch:

permissions:
  contents: read


jobs:
  validate-content:
    name: Validate operation docs content
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Check out the knowledge repository
        uses: actions/checkout@v6
        with:
          repository: DataTalksClub/dataops-knowledge
          token: ${{ secrets.DATAOPS_CONTENT_GITHUB_TOKEN }}
          path: .knowledge
          persist-credentials: false

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

      - name: Install Python
        run: uv python install

      - name: Set up Node.js
        uses: actions/setup-node@v6
        with:
          node-version: "20"
          cache: npm
          cache-dependency-path: package-lock.json

      - name: Install Node workspace dependencies
        run: npm ci

      - name: Validate docs links and workflow doc IDs
        run: npm --prefix backend run validate:docs-links -- --content-root .knowledge/content


      - name: Build search index
        run: |
          mkdir -p .tmp
          npm --prefix backend run build:search-index -- --content-dir ../.knowledge/content --output ../.tmp/dataops-content-search.index

      - name: Smoke test built index
        working-directory: backend
        run: npx tsx scripts/smoke-search-index.ts ../.tmp/dataops-content-search.index