Skip to content

Commit 22d5134

Browse files
dreamorosiam29d
andauthored
chore(maintenance): update release flow diagram (#2322)
* chore(maintenance): update release flow diagram * docs: update diagram & wording --------- Co-authored-by: Alexander Schueren <[email protected]>
1 parent d34c905 commit 22d5134

File tree

1 file changed

+30
-21
lines changed

1 file changed

+30
-21
lines changed

docs/maintainers.md

+30-21
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Once complete, you can start drafting the release notes to let customers know **
174174
175175
#### Release process visualized
176176

177-
Every release makes dozens of checks, linting, canaries and deployments - all of these are automated.
177+
Every release makes dozens of checks, linting, canaries and deployments - all of these are automated through a number of distinct workflows that together make up the release process.
178178

179179
This is a close visual representation of the main steps (GitHub Actions UI should be the source of truth), along with the approximate time it takes for each key step to complete.
180180

@@ -187,42 +187,51 @@ title Release process
187187
dateFormat HH:mm
188188
axisFormat %H:%M
189189
190-
Release start : milestone, m1, 10:00,2m
190+
Release start : milestone, m1, 10:00, 8s
191+
192+
section Version
193+
Bump package version : active, 8s
194+
Create commit (version bump) : active, 8s
195+
Open version PR : active, 8s
196+
197+
Review and merge version PR : milestone, m2
191198
192199
section QA
193-
Quality checks : active, 2.4m
200+
Quality checks : active, 2.4m
194201
195202
section Build
196-
Bundle release artifact (CJS) : active, 39s
203+
Bundle release artifact (CJS+ESM) : active, 39s
197204
198205
section Git release
199-
Bump package version : active, 8s
200-
Package release : active, 8s
201-
Git Tag : active, 8s
202-
Push Tag : active, 8s
206+
Git Tag : active, 8s
207+
Push Tag : active, 8s
203208
204209
section Release
205-
Attest build : active, 8s
206-
Sign attestation : active, attestation, 10:06, 8s
207-
Publish npm.js : active, npm, after attestation, 29s
210+
Attest build : active, 8s
211+
Sign attestation : active, attestation, 10:04, 8s
212+
Publish npm.js : active, npm, after attestation, 40s
208213
209-
npmjs.com release : milestone, m2, 10:06,1s
214+
npmjs.com release : milestone, m3
210215
211216
section Layer release
212-
Build : active, layer_build, 10:08, 6m
213-
Deploy Beta : active, layer_beta, after layer_build, 4.3m
214-
Run Canary Test : active, layer_canary, after layer_beta, 1.4m
215-
Deploy Prod : active, layer_prod, after layer_canary, 4.3m
217+
Build : active, layer_build, 10:05, 2.5m
218+
Deploy Beta : active, layer_beta, after layer_build, 4m
219+
Run Canary Test : active, layer_canary, after layer_beta, 2m
220+
Deploy Prod : active, layer_prod, after layer_canary, 4m
216221
217-
Layer release : milestone, m3, 10:24,1s
222+
Layer release : milestone, m4
218223
219224
section Docs
220-
Create commit (Layer ARN) : active, 10:24, 8s
221-
Release versioned docs : active, 2.4m
225+
Create commit (Layer ARN) : active, 10:18, 8s
226+
Open docs PR : active, 8s
227+
228+
Review andmerge docs PR : milestone, m5
229+
230+
Publish updated docs : active, 2m
222231
223-
Documentation release : milestone, m4, 10:26,1m
232+
Documentation release : milestone, m6
224233
225-
Release complete : milestone, m5, 10:26, 2m
234+
Release complete : milestone, m7
226235
```
227236

228237
#### Drafting release notes

0 commit comments

Comments
 (0)