-
Notifications
You must be signed in to change notification settings - Fork 70
650 lines (639 loc) · 30.1 KB
/
update-snapshots.yml
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
name: Update snapshots
on:
workflow_dispatch:
pull_request:
types: [labeled]
# cancel workflow when a newer version of the workflow is triggered on the same github ref
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
precondition:
name: Determine if this workflow is applicable
runs-on: ${{ vars.RUNS_ON }}
permissions:
pull-requests: write
outputs:
met: ${{ steps.label.outputs.found || steps.workflow_dispatch.outputs.found }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Found workflow disptach
id: workflow_dispatch
if: ${{ github.event_name == 'workflow_dispatch' }}
run: echo "found=true" >> $GITHUB_OUTPUT
- name: Found required label
id: label
if: ${{ github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'update_snapshots') }}
env:
# Required for running `gh`.
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
echo "found=true" >> $GITHUB_OUTPUT
gh pr edit ${{ github.event.number }} --remove-label update_snapshots
get_matrix:
name: Set CI flavors
needs: precondition
if: needs.precondition.outputs.met
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
outputs:
matrix: ${{ steps.get-matrix.outputs.matrix }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- id: get-matrix
run: echo "matrix=$(node ./common/scripts/workflow-read-matrix.mjs)" >> $GITHUB_OUTPUT
component_examples:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update component examples snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
- name: Build Packages
run: rush build -t @azure/communication-react
- name: Build component examples sample application
run: rush build -t component-examples
- name: Update snapshots
id: updatesnapshots
run: |
cd samples/tests
npx playwright install --with-deps
rushx update:snapshot:examples
env:
CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload test results on failure
if: ${{ always() && steps.updatesnapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: samples/tests/test-results
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status samples/tests -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
exit
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add samples/tests/*.png
git commit -m 'Update component examples snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
html_bundle:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update embed html bundle snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
- name: Build Packages
run: rush build -t @azure/communication-react
- name: Build static HTML composite sample application
run: rush build -t sample-static-html-composites
- name: Update snapshot
id: updatesnapshots
run: |
cd samples/tests
npx playwright install --with-deps
rushx update:snapshot:bundle
env:
CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload snapshot diff
if: ${{ always() && steps.updatesnapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: samples/tests/test-results
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status samples/tests -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
exit
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add samples/tests/*.png
git commit -m 'Update embed html bundle snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
call_composite:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update packages/react-composites CallComposite browser test snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
- name: Build packages/react-composites browser tests
working-directory: ./packages/react-composites
run: rushx build:e2e:call
- name: Install packlets used by browser tests
run: |
cd packages/react-composites
rush build -t .
- name: Update CallComposite snapshot
id: update-call-snapshots
run: rushx test:e2e:call:update
working-directory: ./packages/react-composites
env:
CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload snapshot diff
if: ${{ always() && steps.update-call-snapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: packages/react-composites/test-results
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status packages -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add packages/react-composites/*.png
git commit -m 'Update packages/react-composites CallComposite browser test snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
chat_composite:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update packages/react-composites ChatComposite browser test snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
- name: Build packages/react-composites browser tests
working-directory: ./packages/react-composites
run: rushx build:e2e:chat
- name: Install packlets used by browser tests
run: |
cd packages/react-composites
rush build -t .
- name: Update chat snapshot
id: update-chat-snapshots
run: rushx test:e2e:chat:update
working-directory: ./packages/react-composites
env:
CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload snapshot diff
if: ${{ always() && steps.update-chat-snapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: packages/react-composites/test-results
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status packages -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add packages/react-composites/*.png
git commit -m 'Update packages/react-composites ChatComposite browser test snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
callwithchat_composite:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update packages/react-composites CallWithChatComposite browser test snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
- name: Build packages/react-composites browser tests
working-directory: ./packages/react-composites
run: rushx build:e2e:callwithchat
- name: Install packlets used by browser tests
run: |
cd packages/react-composites
rush build -t .
- name: Update call with chat snapshot
id: update-call-with-chat-snapshots
run: rushx test:e2e:callwithchat:update
working-directory: ./packages/react-composites
env:
CONNECTION_STRING: ${{ secrets.CONNECTION_STRING }}
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload snapshot diff
if: ${{ always() && steps.update-call-with-chat-snapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: packages/react-composites/test-results
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status packages -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add packages/react-composites/*.png
git commit -m 'Update packages/react-composites CallWithChatComposite browser test snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
components:
needs: [precondition, get_matrix]
if: needs.precondition.outputs.met
name: Update packages/react-components browser test snapshots
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
strategy:
matrix: ${{ fromJSON(needs.get_matrix.outputs.matrix) }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}
- name: Checkout branch if on a PR
if: ${{ github.event_name != 'workflow_dispatch' }}
# On the `pull_request` event, actions/checkout@v4 leaves the local checkout in a detached head state.
# Explicitly checkout the target branch so we can push later.
run: git checkout ${{ github.event.pull_request.head.ref }}
- name: Setup bot git information
# User id of github actions bot. See https://api.github.com/users/better-informatics%5Bbot%5D
run: |
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config user.name "github-actions[bot]"
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Restore node_modules from cache
uses: actions/cache@v4
with:
path: common/temp/pnpm-store
key: ${{ runner.os }}-${{ hashFiles('common/config/rush/pnpm-lock.yaml') }}
- name: Install rush
run: npm install -g @microsoft/rush@$(jq -r '.rushVersion' "rush.json")
- name: Install dependencies
run: rush install --max-install-attempts 3
- uses: browser-actions/setup-chrome@v1
id: setup-chrome
with:
chrome-version: 120.0.6099
- name: Switch flavor for build
if: ${{ matrix.flavor != 'beta' }}
run: rush switch-flavor:${{ matrix.flavor }}
# Build the packages
# This is needed because react-components depends on acs-ui-common and
# acs-ui-common specifies main/module variables in package.json
- name: Build Common Package
run: rush build -t acs-ui-common
- name: Update components snapshots
id: update-components-snapshots
run: rushx test:components:update
working-directory: ./packages/react-components
env:
CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
- name: Upload snapshot diff
if: ${{ always() && steps.update-components-snapshots.outcome == 'failure' }}
uses: actions/upload-artifact@v4
with:
name: snapshots
path: packages/react-components/tests/temp/
# Check if files have changed
# More information see: https://stackoverflow.com/questions/3878624/how-do-i-programmatically-determine-if-there-are-uncommitted-changes
- name: Check for snapshot changes
id: changescheck
run: |
if [[ -z $(git status packages -s) ]]
then
echo "hasChanged=false" >> $GITHUB_OUTPUT
else
echo "hasChanged=true" >> $GITHUB_OUTPUT
fi
- name: Push new snapshots, if any
if: ${{ steps.changescheck.outputs.hasChanged == 'true' }}
# Before pushing changes to origin, merge any intervening changes on the upstream branch.
# This allows multiple snapshot update jobs in this action to run concurrently.
# - The only files updated locally are UI snapshots
# - Each job is responsible for a unique set of UI snapshots
# Thus we do not expect any merge conflicts due to the concurrent jobs from this workflows.
#
# If the UI snapshots are updated in the upstream branch while this job was running
# (e.g., due to a merge from the base_ref for a PR), this merge will fail, and the
# workflow will have to be triggered again. This is the desired behavior because the workflow
# should not silently overwrite updates to the target branch.
run: |
git add packages/react-components/*.png
git commit -m 'Update packages/react-components browser test snapshots'
git pull origin ${{ needs.get_target_branch.outputs.target }} --no-rebase --no-edit
git push
push_updated_snapshots:
needs: [component_examples, html_bundle, call_composite, chat_composite, callwithchat_composite]
if: needs.precondition.outputs.met
name: Push all updated snapshots to branch
runs-on: ${{ vars.RUNS_ON }}
permissions: read-all
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
# Use a machine account when checking out. This is to workaround the issue where GitHub
# actions, when using the default account, cannot trigger other actions.
# This machine account is only for this PAT, pwd was created and thrown away
# If an update is needed, create a new account, add access to the repo and generate a new PAT
token: ${{ secrets.MACHINE_ACCOUNT_PAT }}