Skip to content

Commit a0a0978

Browse files
DilumAluthgeomus
DilumAluthge
and
omus
authored
Simplify the release process (no more build script or release branches) (#281)
* Simplify the release process (no more build script or release branches) * Remove the `bin/` submodule * npm run pack * Use a different YAML syntax Co-authored-by: Curtis Vogt <[email protected]> * Use simpler (but equivalent) logic Co-authored-by: Curtis Vogt <[email protected]> * Fix a logic bug * Remove some job matrices Co-authored-by: Curtis Vogt <[email protected]> * Intentionally fail a job (to make sure that `finalize` thus also fails) * Revert "Intentionally fail a job (to make sure that `finalize` thus also fails)" This reverts commit cd7944c. --------- Co-authored-by: Curtis Vogt <[email protected]>
1 parent 54be0dc commit a0a0978

12 files changed

+38635
-148
lines changed

‎.github/workflows/checkin.yml

-36
This file was deleted.

‎.github/workflows/pr_checks.yml

+222
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,222 @@
1+
name: PR Checks
2+
on:
3+
pull_request:
4+
push:
5+
branches:
6+
- master
7+
tags: '*'
8+
concurrency:
9+
# Skip intermediate builds: all builds except for builds on the `master` branch
10+
# Cancel intermediate builds: only pull request builds
11+
group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref != 'refs/heads/master' || github.run_number }}
12+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
13+
permissions:
14+
contents: read
15+
jobs:
16+
finalize-pr-checks:
17+
if: always() # this line is important to keep the `finalize` job from being marked as skipped; do not change or delete this line
18+
runs-on: ubuntu-latest
19+
timeout-minutes: 10
20+
needs:
21+
- checked-in-files
22+
- build
23+
- npm-run-test
24+
- make-targets
25+
- stalecheck-npm-install
26+
steps:
27+
- run: |
28+
echo checked-in-files: ${{ needs.checked-in-files.result }}
29+
echo build: ${{ needs.build.result }}
30+
echo npm-run-test: ${{ needs.npm-run-test.result }}
31+
echo make-targets: ${{ needs.make-targets.result }}
32+
echo stalecheck-npm-install: ${{ needs.stalecheck-npm-install.result }}
33+
- run: exit 1
34+
if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped') }}
35+
checked-in-files:
36+
timeout-minutes: 30
37+
runs-on: ubuntu-latest
38+
strategy:
39+
fail-fast: false
40+
steps:
41+
### Check out the repo:
42+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
43+
with:
44+
persist-credentials: false
45+
### Cleanall:
46+
- run: make cleanall
47+
### Install NodeJS
48+
# Unix (non-Windows):
49+
- uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
50+
if: runner.os != 'Windows'
51+
- run: make unix-asdf-install
52+
if: runner.os != 'Windows'
53+
# Windows:
54+
# Windows does not support asdf, so we have to use `actions/setup-node`
55+
# to install asdf:
56+
- uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b
57+
if: runner.os == 'Windows'
58+
with:
59+
node-version-file: '.tool-versions'
60+
### Install the NodeJS packages that we depend on:
61+
- run: make install-packages
62+
### Print some debugging info:
63+
- name: Print the NodeJS version (for debugging)
64+
run: |
65+
which -a node
66+
node --version
67+
which -a npm
68+
npm --version
69+
### Build:
70+
- run: make pack
71+
### Clean (not cleanall!):
72+
- run: make clean
73+
### Make sure there are no uncommited changes
74+
- uses: julia-actions/setup-julia@780022b48dfc0c2c6b94cfee6a9284850107d037
75+
with:
76+
version: '1'
77+
- run: git --no-pager status
78+
- run: git --no-pager diff
79+
- run: julia ./ci/check_uncommitted_changes.jl
80+
build:
81+
timeout-minutes: 30
82+
runs-on: ubuntu-latest
83+
steps:
84+
### Check out the repo:
85+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
86+
with:
87+
persist-credentials: false
88+
### Cleanall:
89+
- run: make cleanall
90+
### Install NodeJS
91+
# Unix (non-Windows):
92+
- uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
93+
if: runner.os != 'Windows'
94+
- run: make unix-asdf-install
95+
if: runner.os != 'Windows'
96+
# Windows:
97+
# Windows does not support asdf, so we have to use `actions/setup-node`
98+
# to install asdf:
99+
- uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b
100+
if: runner.os == 'Windows'
101+
with:
102+
node-version-file: '.tool-versions'
103+
### Install the NodeJS packages that we depend on:
104+
- run: make install-packages
105+
### Print some debugging info:
106+
- name: Print the NodeJS version (for debugging)
107+
run: |
108+
which -a node
109+
node --version
110+
which -a npm
111+
npm --version
112+
### Build:
113+
- run: make build
114+
- run: make pack
115+
### Make sure some other `make` targets don't bitrot:
116+
- name: Run some other `make` targets to ensure that they don't bitrot
117+
run: |
118+
make clean
119+
make cleanall
120+
- name: Run all of the "cleaning" `make` targets to ensure that they don't bitrot
121+
run: |
122+
make clean
123+
make cleanall
124+
npm-run-test:
125+
timeout-minutes: 30
126+
runs-on: ubuntu-latest
127+
steps:
128+
### Check out the repo:
129+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
130+
with:
131+
persist-credentials: false
132+
### Cleanall:
133+
- run: make cleanall
134+
### Install NodeJS
135+
# Unix (non-Windows):
136+
- uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
137+
if: runner.os != 'Windows'
138+
- run: make unix-asdf-install
139+
if: runner.os != 'Windows'
140+
# Windows:
141+
# Windows does not support asdf, so we have to use `actions/setup-node`
142+
# to install asdf:
143+
- uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b
144+
if: runner.os == 'Windows'
145+
with:
146+
node-version-file: '.tool-versions'
147+
### Install the NodeJS packages that we depend on:
148+
- run: make install-packages
149+
### Print some debugging info:
150+
- name: Print the NodeJS version (for debugging)
151+
run: |
152+
which -a node
153+
node --version
154+
which -a npm
155+
npm --version
156+
### Build:
157+
- run: make build
158+
- run: make test
159+
make-targets: # This is a job to make sure that none of the `make` targets bitrot
160+
timeout-minutes: 30
161+
runs-on: ubuntu-latest
162+
steps:
163+
### Check out the repo:
164+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
165+
with:
166+
persist-credentials: false
167+
### Cleanall:
168+
- run: make cleanall
169+
### Install NodeJS
170+
# Unix (non-Windows):
171+
- uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
172+
if: runner.os != 'Windows'
173+
- run: make unix-asdf-install
174+
if: runner.os != 'Windows'
175+
### Install the NodeJS packages that we depend on:
176+
- run: make install-packages
177+
### Make sure some other `make` targets don't bitrot:
178+
- name: Run some other `make` targets to ensure that they don't bitrot
179+
run: |
180+
make unix-asdf-install
181+
make install-packages
182+
make build
183+
make pack
184+
make everything-from-scratch
185+
- name: Run all of the "cleaning" `make` targets to ensure that they don't bitrot
186+
run: |
187+
make clean
188+
make cleanall
189+
stalecheck-npm-install:
190+
# In this job, we are basically trying to check if `package-lock.json` is in
191+
# sync with `package-lock.json`.
192+
#
193+
# So, for example, if someone manually edits the `package.json` file, we want
194+
# to make sure that the `package-lock.json` file is not out of sync with the
195+
# `package.json` file.
196+
timeout-minutes: 30
197+
runs-on: ubuntu-latest
198+
strategy:
199+
fail-fast: false
200+
steps:
201+
### Check out the repo:
202+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
203+
with:
204+
persist-credentials: false
205+
### Install NodeJS
206+
# Unix (non-Windows):
207+
- uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
208+
if: runner.os != 'Windows'
209+
- run: make unix-asdf-install
210+
if: runner.os != 'Windows'
211+
### Run the master commands for this job:
212+
- run: make clean
213+
- run: npm ci
214+
# - run: npm install --package-lock-only
215+
- run: npm install
216+
### Make sure there are no uncommited changes
217+
- uses: julia-actions/setup-julia@780022b48dfc0c2c6b94cfee6a9284850107d037
218+
with:
219+
version: '1'
220+
- run: git --no-pager status
221+
- run: git --no-pager diff
222+
- run: julia ./ci/check_uncommitted_changes.jl

‎.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
node_modules/
22
__tests__/runner/*
3-
dist/

‎.gitmodules

-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +0,0 @@
1-
[submodule "bin"]
2-
path = bin
3-
url = [email protected]:julia-actions/bin.git

‎Makefile

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
.NOTPARALLEL:
2+
3+
# This is the default target:
4+
.PHONY: pack
5+
pack: build
6+
npm run pack
7+
8+
# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
9+
10+
.PHONY: everything-from-scratch
11+
everything-from-scratch: cleanall install-packages build pack clean
12+
13+
# build does `npm run build`, but does not run `npm run pack`
14+
.PHONY: build
15+
build:
16+
npm run build
17+
18+
.PHONY: test
19+
test:
20+
npm run test
21+
22+
.PHONY: install-packages
23+
install-packages:
24+
rm -rf node_modules/
25+
# Note: we use `npm ci` instead of `npm install`, because we want to make sure
26+
# that we respect the versions in the `package-lock.json` lockfile.
27+
npm ci
28+
29+
# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
30+
31+
.PHONY: clean
32+
clean:
33+
rm -rf node_modules/
34+
35+
.PHONY: cleanall
36+
cleanall: clean
37+
rm -rf lib/
38+
rm -rf dist/
39+
40+
# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
41+
42+
# asdf does not support Windows.
43+
# On Windows, users need to install the correct version of NodeJS themselves.
44+
.PHONY: unix-asdf-install
45+
unix-asdf-install:
46+
asdf plugin add nodejs # update this list when we add more tools to `.tool-versions`
47+
asdf install
48+
49+
# +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

‎bin

-1
This file was deleted.

‎ci/check_uncommitted_changes.jl

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
const cmd = `git --no-pager diff --exit-code --stat`
2+
3+
const proc = run(pipeline(cmd; stdin, stdout, stderr); wait = false)
4+
5+
wait(proc)
6+
7+
@info "" success(proc) proc.exitcode
8+
9+
if !success(proc)
10+
recommended_cmd = "make everything-from-scratch"
11+
msg = "##[error] found changed files after build. " *
12+
"Please run `$(recommended_cmd)` and " *
13+
"then check in all changes."
14+
println(stderr, msg)
15+
exit(1)
16+
end

‎devdocs/local_setup.md

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ First, `cd` to your clone of the repo. Now you can run the following commands:
4242
npm ci
4343

4444
npm run build
45+
46+
npm run pack
4547
```
4648

4749
When you are ready, you can commit your changes and push them to your PR.

0 commit comments

Comments
 (0)