forked from mdn/content
170 lines (144 loc) · 6.39 KB
/
pr-test.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
# This file tests more or less everything related to a pull request. All
# in one big job. At the end, if all the testing passes, it proceeds
# to upload all the files that were built to our Dev environment.
# This way, if the tests passed, you'll be able to review the built
# pages on a public URL.
name: PR Test
on:
# The reason for building once it's pushed to `main`, too, is an
# optimization. This way, when workflow is built on the `main` branch
# anything that's stored in the cache (e.g. node_modules) can be
# re-used by consecutive PRs in other branches.
# See https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
# and https://github.community/t/how-come-the-actions-cache-is-failing-so-much-often/196279/3
push:
branches:
- main
pull_request:
jobs:
tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Node.js environment
uses: actions/setup-node@v3.1.0
with:
node-version: "12"
cache: yarn
- name: Install all yarn packages
run: |
yarn --frozen-lockfile
- name: Config git core.quotePath
run: |
# If you don't do this, the get-diff-action won't be able to
# notice files that contain non-ascii characters.
# I.e.
#
# ▶ git status
# Changes not staged for commit:
# ...
# modified: "files/en-us/glossary/b\303\251zier_curve/index.html"
#
# But after you set `core.quotePath` you get:
#
# ▶ git status
# Changes not staged for commit:
# ...
# modified: "files/en-us/glossary/bézier_curve/index.html"
#
# Now, this gets used by the `git diff ...` inside get-diff-action.
git config --global core.quotePath false
- uses: technote-space/get-diff-action@v6.0.1
id: git_diff_content
with:
PATTERNS: files/**/*.+(html|md)
SET_ENV_NAME: GIT_DIFF_CONTENT
- name: Build changed content
if: ${{ env.GIT_DIFF_CONTENT }}
env:
CONTENT_ROOT: ${{ github.workspace }}/files
# This is so that if there's a single 'unsafe_html' flaw, it
# completely fails the build.
# But all other flaws should be 'warn', so that we can include
# information about the flaws when we analyze the built PR.
BUILD_FLAW_LEVELS: "unsafe_html: error, *:warn"
# Because we build these pages in a way that you get a toolbar,
# so the flaws can be displayed, but we don't want any of the
# other toolbar features like "Fix fixable flaws" or "Quick-edit"
# we set this to disable that stuff.
REACT_APP_CRUD_MODE_READONLY: true
# Setting this to an empty string effectively means that the
# <iframe> src will end up being the relative URL of the current
# document as a base.
# I.e. like this, if the current document is '/en-US/docs/Foo':
# <iframe src="/en-US/docs/Foo/_samples_/index.html">
# ...for example.
# Yes, it's potentially "insecure" because the iframe will execute
# whatever code is inserted into the code example. But since the
# whole (possible) domain for PR builds will never be somewhere
# where there are interesting cookies, it's a safe choice.
BUILD_LIVE_SAMPLES_BASE_URL: ""
# In these builds, we never care for or need the ability to sign in.
# This environment variable will disable that functionality entirely.
REACT_APP_DISABLE_AUTH: true
# TODO: This should be implicit when `CI=true`
BUILD_NO_PROGRESSBAR: true
run: |
# The reason this script isn't in `package.json` is because
# you don't need that script as a writer. It's only used in CI
# and it can't use the default CONTENT_ROOT that gets set in
# package.json.
yarn build ${{ env.GIT_DIFF_CONTENT }}
echo "Disk usage size of build/"
du -sh $BUILD_OUT_ROOT
# Save the PR number into the build
echo ${{ github.event.number }} > build/NR
# Save the raw diff blob and store that inside the ./build/
# directory.
# The purpose of this is for the PR Review Companion to later
# be able to use this raw diff file for the benefit of analyzing.
git diff --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }} > build/DIFF
- name: Merge static assets with built documents
if: ${{ env.GIT_DIFF_CONTENT }}
run: |
rsync -a node_modules/@mdn/yari/client/build/ build/
# Now that build/ directory contains everything you need to deploy
# that as a site. HTML, static assets, images, etc.
# However, that Yari static files is very heavy and it's in large
# part due to the .map files.
# In fact, as of March 2021, the client/build/static directory
# is 2.3MB but only 864KB without all the .map files.
# Let's delete those this time because this isn't the right time
# to debug JS or CSS.
echo "Before..."
du -sh build
find build/static -type f -name "*.map" | xargs ls -lh
find build/static -type f -name "*.map" | xargs rm
echo "After..."
du -sh build
- uses: actions/upload-artifact@v3
if: ${{ env.GIT_DIFF_CONTENT }}
with:
name: build
path: build/
- uses: technote-space/get-diff-action@v6.0.1
with:
PATTERNS: files/**/*.+(png|jpeg|jpg|gif|svg|webp)
ABSOLUTE: true
SET_ENV_NAME: GIT_DIFF_FILES
- name: Check changed files
if: ${{ env.GIT_DIFF_FILES }}
run: |
echo ${{ env.GIT_DIFF_FILES }}
export CONTENT_ROOT=$(pwd)/files
yarn filecheck ${{ env.GIT_DIFF_FILES }}
- uses: technote-space/get-diff-action@v6.0.1
id: git_diff_redirects
with:
PATTERNS: files/**/_redirects.txt
SET_ENV_NAME: GIT_DIFF_REDIRECTS
- name: Validate redirects
if: ${{ env.GIT_DIFF_REDIRECTS }}
run: |
echo ${{ env.GIT_DIFF_REDIRECTS }}
yarn content validate-redirects