-
Notifications
You must be signed in to change notification settings - Fork 5
155 lines (127 loc) · 6.66 KB
/
component-tests_template.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
name: Kitbook Visual Regression Tests - Template
# Set all of these 👇
env:
PLAYWRIGHT_BASE_URL: ${{ github.event.deployment_status.target_url }}
UPDATE_SNAPSHOTS_SCRIPT: pnpm build && pnpm -F template test:components:update
COMPARE_SNAPSHOTS_SCRIPT: pnpm build && pnpm -F template test:components
GOOGLE_CLOUD_CREDENTIALS: ${{ secrets.GCS_COMPONENT_CHECK_BUCKETS_CREDENTIALS }}
BUCKET_NAME: component-snapshots
PROJECT_NAME: kitbook-template
PROJECT_ROOT: ./packages/template
KITBOOK_ROUTE: kitbook
on:
deployment_status
permissions:
pull-requests: write
jobs:
update-base-snapshots:
name: Keep Base Component Snapshots In Sync with Main Branch
if: github.event.deployment_status.state == 'success' && github.event.deployment_status.environment == 'Production – kitbook-template' # 👈 set this
runs-on: ubuntu-latest
timeout-minutes: 15
container:
image: mcr.microsoft.com/playwright:v1.43.1-jammy # 👈 keep version in sync with installed playwright package https://playwright.dev/docs/ci#github-actions-via-containers
steps:
- uses: actions/checkout@v3
- name: Install pnpm
uses: pnpm/action-setup@v2
with:
version: 8.6.0
- uses: actions/setup-node@v3
with:
node-version: 18
cache: pnpm
- name: Install Dependencies
run: pnpm install
- name: Run Playwright Component tests to save snapshots
run: eval $UPDATE_SNAPSHOTS_SCRIPT
env:
CI: true
# PLAYWRIGHT_BASE_URL is set above already, otherwise it would need set here
- name: Authenticate to Google Cloud
id: auth
uses: google-github-actions/auth@v1
with:
credentials_json: '${{ env.GOOGLE_CLOUD_CREDENTIALS }}'
- name: Set up Google Cloud SDK
uses: google-github-actions/setup-gcloud@v1 # automatically picks up authentication from `auth`
- name: Wipe Base Clean
run: gcloud storage rm gs://${BUCKET_NAME}/${PROJECT_NAME}/base/**
continue-on-error: true # ignore errors emitted when nothing is found to delete
- name: Upload Base Snapshots
run: gcloud storage cp --recursive ${PROJECT_ROOT}/e2e/snapshots gs://${BUCKET_NAME}/${PROJECT_NAME}/base/snapshots # 👈 recommend you setup your playwright.config.ts to save snapshots into $PROJECT_ROOT/e2e/snapshots to make this work smoothly (gcloud will create a base/snapshots folder if you just copy from e2e/snapshots to base, so if you tried to copy from e2e/foo to base/snapshots, I suspect things will land in base/snapshots/foo which will break things further on if you don't adjust) see https://cloud.google.com/sdk/gcloud/reference/storage for help if you do modify the commands
compare-snapshots:
name: Compare Components Against Base Snapshots
if: github.event.deployment_status.state == 'success' && github.event.deployment_status.environment == 'Preview – kitbook-template' # 👈 set this
runs-on: ubuntu-latest
timeout-minutes: 15
container:
image: mcr.microsoft.com/playwright:v1.43.1-jammy # 👈 keep version in sync with installed playwright package https://playwright.dev/docs/ci#github-actions-via-containers
steps:
- uses: actions/checkout@v3
- name: Install pnpm
uses: pnpm/action-setup@v2
with:
version: 8.6.0
- uses: actions/setup-node@v3
with:
node-version: 18
cache: pnpm
- name: Install Dependencies
run: pnpm install
- name: Authenticate to Google Cloud
id: auth
uses: google-github-actions/auth@v1
with:
credentials_json: '${{ env.GOOGLE_CLOUD_CREDENTIALS }}'
- name: Set up Google Cloud SDK
uses: google-github-actions/setup-gcloud@v1
- name: Download Base Snapshots
run: gcloud storage cp --recursive gs://${BUCKET_NAME}/${PROJECT_NAME}/base/snapshots ${PROJECT_ROOT}/e2e # 👈 recommend you setup your playwright.config.ts to save snapshots into $PROJECT_ROOT/e2e/snapshots to make this work smoothly
- name: Run Playwright Component tests to get snapshot comparison files
run: eval $COMPARE_SNAPSHOTS_SCRIPT
env:
CI: true
# PLAYWRIGHT_BASE_URL is set above already, otherwise it would need set here
continue-on-error: true # expect an error when components change
- uses: jwalton/gh-find-current-pr@v1
id: findPr
- name: Remove Old Report and Test Results
run: gcloud storage rm gs://${BUCKET_NAME}/${PROJECT_NAME}/pr/${{ steps.findPr.outputs.pr }}/**
continue-on-error: true # ignore error emitted when nothing found to delete for this PR
- name: Upload Playwright Report
run: gcloud storage cp --recursive ${PROJECT_ROOT}/playwright-report gs://${BUCKET_NAME}/${PROJECT_NAME}/pr/${{ steps.findPr.outputs.pr }}/playwright-report
continue-on-error: true # ignore error when no components have changed and there is no report
- name: Upload Test Results (Snapshots)
id: upload-snapshots
uses: google-github-actions/upload-cloud-storage@v1 # use this instead of gcloud cli to easily output uploaded filenames
with:
path: '${{ env.PROJECT_ROOT }}/test-results'
destination: '${{ env.BUCKET_NAME }}/${{ env.PROJECT_NAME }}/pr/${{ steps.findPr.outputs.pr }}'
continue-on-error: true # ignore error when no components have changed and there is no report
- name: Format Changed Component Snapshots for PR
if: steps.findPr.outputs.number && steps.upload-snapshots.outputs.uploaded
id: format_snapshot_links_for_pr
uses: jacob-8/kitbook/packages/format-snapshot-results-action@v1 # use ./packages/format-snapshot-results-action for local testing
with:
upload-results: '${{ steps.upload-snapshots.outputs.uploaded }}'
pr: '${{ steps.findPr.outputs.pr }}'
bucket: '${{ env.BUCKET_NAME }}'
project: '${{ env.PROJECT_NAME }}'
deployment-url: '${{ env.PLAYWRIGHT_BASE_URL }}'
kitbook-route: '${{ env.KITBOOK_ROUTE }}'
- name: Add Changed Component Snapshots to PR
if: steps.findPr.outputs.number && steps.format_snapshot_links_for_pr.outputs.comment
uses: marocchino/sticky-pull-request-comment@v2
with:
number: ${{ steps.findPr.outputs.pr }}
recreate: true
header: ${{ env.PROJECT_NAME }}
message: |
${{ steps.format_snapshot_links_for_pr.outputs.comment }}
- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright-report
path: ${{ env.PROJECT_ROOT }}/playwright-report/
retention-days: 30