typespec-azure/.github/workflows/consistency.yml at c14f9cd646904340defec9f03b7af70b449a82a7 · Azure/typespec-azure · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
name: Consistency

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  push:
    branches: ["main", "release/*"]
  pull_request:
    branches: ["main", "release/*"]
  merge_group:
  workflow_dispatch: {}

permissions:
  contents: read

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  check-changes:
    name: Check Changes
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0 ## Needed for Changesets to find `main` branch
          submodules: recursive

      - uses: ./.github/actions/setup

      - run: git pull --force --no-tags origin ${{ github.event.pull_request.base.ref }}:${{ github.event.pull_request.base.ref }}
        name: Get ${{ github.event.pull_request.base.ref }} ref for ${{ github.ref}}, evt ${{ github.event_name }}

      - run: pnpm install
        name: Install dependencies

      - name: Create PR comment
        run: pnpm chronus-github get-pr-comment --out ./comment-out/comment.json
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        if: |
          !startsWith(github.head_ref, 'publish/')

      - uses: actions/upload-artifact@v7
        with:
          name: comment
          path: comment-out/
          retention-days: 1 # Only needed by the commenter workflow, so no need to waste storage
        if: |
          !startsWith(github.head_ref, 'publish/')

      - run: npx chronus verify --since ${{ github.event.pull_request.base.ref }}
        name: Check changelog
        if: |
          !startsWith(github.head_ref, 'publish/') &&
          !startsWith(github.head_ref, 'dependabot/') &&
          !startsWith(github.head_ref, 'backmerge/') &&
          !startsWith(github.head_ref, 'revert-') &&
          !contains(github.event.pull_request.title, '[skip chg]')

      - run: node eng/scripts/validate-core-submodule.js
        name: Check that core submodule is merged to core repo
        if: |
          !startsWith(github.base_ref, 'release/')

  # Validate spell check
  spellcheck:
    name: Spell check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: recursive
      - uses: ./.github/actions/setup

      - run: pnpm install
        name: Install dependencies

      - run: pnpm run cspell
        name: Spell check

  # Validate formatting
  format:
    name: Format
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: recursive
      - uses: ./.github/actions/setup

      - run: pnpm install
        name: Install dependencies

      - run: pnpm --filter="@typespec/prettier-plugin-typespec..." run  build
        name: Build prettier plugin

      - run: pnpm run format:check
        name: Check formatting

      - run: pnpm run format:extra:check
        name: Check formatting (Extra)

  # Lint
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: recursive

      - uses: ./.github/actions/setup

      - run: pnpm install
        name: Install dependencies

      # Force the `unix` reporter (instead of oxlint's default GitHub Actions
      # reporter) so the full `file:line:col` location stays visible in the job
      # logs, and register a problem matcher so violations still surface as
      # inline annotations on the PR.
      - name: Add oxlint Problem Matcher
        run: echo "::add-matcher::.github/matchers/oxlint.json"

      - run: pnpm run lint:ci
        name: Lint

      - run: pnpm run lint:extra
        name: Lint (Extra)

      # cspell:ignore rhysd
      # Content copied from https://raw.githubusercontent.com/rhysd/actionlint/2ab3a12c7848f6c15faca9a92612ef4261d0e370/.github/actionlint-matcher.json
      - name: Add ActionLint Problem Matcher
        run: echo "::add-matcher::.github/matchers/actionlint.json"

      - name: Lint GitHub Actions workflows
        uses: docker://rhysd/actionlint:1.7.11
        with:
          args: -color -verbose

  # Check catalog is in sync with core
  version-consistency:
    name: Versions consistency
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: recursive

      - uses: ./.github/actions/setup

      - run: pnpm install
        name: Install dependencies

      - run: pnpm deps check
        name: Check catalog is in sync

      - run: pnpm run check-lockfile
        name: Check lockfile has no tarball URLs

  # Verify Arm OpenAPI common types are up to date
  common-types-up-to-date:
    name: Common types up to date
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          submodules: recursive

      - uses: ./.github/actions/setup

      - run: pnpm install
        name: Install dependencies

      - run: node eng/scripts/sync-common-types.ts
        name: Swagger - Fetch common-types v3

      - run: node eng/scripts/check-for-changed-files.js
        name: Check Git Status For Changed Files