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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
name: diff-shades
on:
push:
branches: [main]
paths: ["src/**", "pyproject.toml", ".github/workflows/*"]
pull_request:
paths: ["src/**", "pyproject.toml", ".github/workflows/*"]
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.run_id }}
cancel-in-progress: true
env:
HATCH_BUILD_HOOKS_ENABLE: "1"
# Clang is less picky with the C code it's given than gcc (and may generate faster
# binaries too).
CC: clang-18
jobs:
configure:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-config.outputs.matrix }}
steps:
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Install diff-shades and support dependencies
run: |
python -m pip install 'click>=8.1.7' packaging urllib3
python -m pip install https://github.com/ichard26/diff-shades/archive/stable.zip
- name: Calculate run configuration & metadata
id: set-config
env:
GITHUB_TOKEN: ${{ github.token }}
run: python scripts/diff_shades_gha_helper.py config ${{ github.event_name }}
analysis-base:
name: analysis / base / ${{ matrix.mode }}
needs: configure
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- name: Checkout this repository (full clone)
uses: actions/checkout@v6
with:
# The baseline revision could be rather old so a full clone is ideal.
fetch-depth: 0
- uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Install diff-shades
run: |
python -m pip install https://github.com/ichard26/diff-shades/archive/stable.zip
git config user.name "diff-shades-gha"
git config user.email "diff-shades-gha@example.com"
- name: Attempt to use cached baseline analysis
id: baseline-cache
uses: actions/cache@v4
with:
path: ${{ matrix.baseline-analysis }}
key: ${{ matrix.baseline-cache-key }}
- name: Build and install baseline revision
if: steps.baseline-cache.outputs.cache-hit != 'true'
env:
GITHUB_TOKEN: ${{ github.token }}
run: >
${{ matrix.baseline-setup-cmd }}
&& python -m pip install .
- name: Analyze baseline revision
if: steps.baseline-cache.outputs.cache-hit != 'true'
run: >
diff-shades analyze ${{ matrix.baseline-analysis }}
-v --work-dir projects-cache/ ${{ matrix.force-flag }}
- name: Upload baseline analysis
uses: actions/upload-artifact@v5
with:
name: ${{ matrix.baseline-analysis }}
path: ${{ matrix.baseline-analysis }}
analysis-target:
name: analysis / target / ${{ matrix.mode }}
needs: configure
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- name: Checkout this repository (full clone)
uses: actions/checkout@v6
with:
# The baseline revision could be rather old so a full clone is ideal.
fetch-depth: 0
- uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Install diff-shades
run: |
python -m pip install https://github.com/ichard26/diff-shades/archive/stable.zip
git config user.name "diff-shades-gha"
git config user.email "diff-shades-gha@example.com"
- name: Build and install target revision
env:
GITHUB_TOKEN: ${{ github.token }}
run: >
${{ matrix.target-setup-cmd }}
&& python -m pip install .
# Pull it from previous runs - we're NOT trying to get it from this run
# (but it wouldn't cause problems if we theoretically did)
- name: Attempt to find baseline analysis
id: baseline-cache
uses: actions/cache@v4
with:
path: ${{ matrix.baseline-analysis }}
key: ${{ matrix.baseline-cache-key }}
- name: Analyze target revision (with repeated projects)
if: steps.baseline-cache.outputs.cache-hit == 'true'
run: >
diff-shades analyze ${{ matrix.target-analysis }}
-v --work-dir projects-cache/ ${{ matrix.force-flag }}
--repeat-projects-from ${{ matrix.baseline-analysis }}
- name: Analyze target revision (without repeated projects)
if: steps.baseline-cache.outputs.cache-hit != 'true'
run: >
diff-shades analyze ${{ matrix.target-analysis }}
-v --work-dir projects-cache/ ${{ matrix.force-flag }}
- name: Upload target analysis
uses: actions/upload-artifact@v5
with:
name: ${{ matrix.target-analysis }}
path: ${{ matrix.target-analysis }}
- name: Check for failed files for target revision
run: >
diff-shades show-failed --check --show-log ${{ matrix.target-analysis }}
compare:
name: compare / ${{ matrix.mode }}
needs: ["configure", "analysis-base", "analysis-target"]
if: ${{ !cancelled() }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
include: ${{ fromJson(needs.configure.outputs.matrix) }}
steps:
- uses: actions/checkout@v6
- uses: actions/download-artifact@v6
with:
merge-multiple: true
- uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Install diff-shades and support dependencies
run: |
python -m pip install 'click>=8.1.7' packaging urllib3
python -m pip install https://github.com/ichard26/diff-shades/archive/stable.zip
- name: Generate HTML diff report
run: >
diff-shades --dump-html diff.html compare --diff
${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }}
- name: Upload diff report
uses: actions/upload-artifact@v5
with:
name: ${{ matrix.mode }}-diff.html
path: diff.html
- name: Generate summary file (PR only)
if: github.event_name == 'pull_request' && matrix.mode == 'preview-new-changes'
run: >
python scripts/diff_shades_gha_helper.py comment-body
${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }}
${{ matrix.baseline-sha }} ${{ matrix.target-sha }}
${{ github.event.pull_request.number }}
- name: Upload summary file (PR only)
if: github.event_name == 'pull_request' && matrix.mode == 'preview-new-changes'
uses: actions/upload-artifact@v5
with:
name: .pr-comment.json
path: .pr-comment.json
include-hidden-files: true
- name: Verify zero changes (PR only)
if: matrix.mode == 'assert-no-changes'
run: >
diff-shades compare --check ${{ matrix.baseline-analysis }} ${{ matrix.target-analysis }}
|| (echo "Please verify you didn't change the stable code style unintentionally!" && exit 1)
|
