copilot-sdk/.github/workflows/docs-validation.yml at main · github/copilot-sdk · 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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
name: "Documentation Validation"

on:
  pull_request:
    paths:
      - 'docs/**'
      - 'nodejs/src/**'
      - 'python/copilot/**'
      - 'go/**/*.go'
      - 'dotnet/src/**'
      - 'scripts/docs-validation/**'
      - '.github/workflows/docs-validation.yml'
  workflow_dispatch:
  merge_group:

permissions:
  contents: read

jobs:
  validate-typescript:
    name: "Validate TypeScript"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6
        with:
          node-version: 22
          cache: "npm"
          cache-dependency-path: "nodejs/package-lock.json"

      - name: Install SDK dependencies
        working-directory: nodejs
        run: npm ci --ignore-scripts

      - name: Install validation dependencies
        working-directory: scripts/docs-validation
        run: npm ci

      - name: Extract and validate TypeScript
        working-directory: scripts/docs-validation
        run: npm run extract && npm run validate:ts

  validate-python:
    name: "Validate Python"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6
        with:
          node-version: 22

      - uses: actions/setup-python@v6
        with:
          python-version: "3.12"

      - name: Install uv
        uses: astral-sh/setup-uv@v7

      - name: Install SDK dependencies
        working-directory: python
        run: uv sync

      - name: Install mypy
        run: pip install mypy

      - name: Install validation dependencies
        working-directory: scripts/docs-validation
        run: npm ci

      - name: Extract and validate Python
        working-directory: scripts/docs-validation
        run: npm run extract && npm run validate:py

  validate-go:
    name: "Validate Go"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6
        with:
          node-version: 22

      - uses: actions/setup-go@v6
        with:
          go-version: "1.24"
          cache-dependency-path: "go/go.sum"

      - name: Install validation dependencies
        working-directory: scripts/docs-validation
        run: npm ci

      - name: Extract and validate Go
        working-directory: scripts/docs-validation
        run: npm run extract && npm run validate:go

  validate-csharp:
    name: "Validate C#"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-node@v6
        with:
          node-version: 22

      - uses: actions/setup-dotnet@v5
        with:
          dotnet-version: "10.0.x"

      - name: Install validation dependencies
        working-directory: scripts/docs-validation
        run: npm ci

      - name: Restore SDK dependencies
        working-directory: dotnet
        run: dotnet restore

      - name: Extract and validate C#
        working-directory: scripts/docs-validation
        run: npm run extract && npm run validate:cs