From d204bbbaeee71b403b1ddc251a10b594fbdc85f3 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Fri, 5 Apr 2024 14:50:39 +0200 Subject: [PATCH 1/2] chore(maintenance): update release flow diagram --- docs/maintainers.md | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/docs/maintainers.md b/docs/maintainers.md index fd8480f687..0dcfe9c710 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -187,42 +187,46 @@ title Release process dateFormat HH:mm axisFormat %H:%M -Release start : milestone, m1, 10:00,2m +Release start : milestone, m1, 10:00, 8s + +section Version + Bump package version : active, 8s + Create commit (version bump) : active, 8s + Review & merge PR : active, 8s section QA - Quality checks : active, 2.4m + Quality checks : active, 2.4m section Build - Bundle release artifact (CJS) : active, 39s + Bundle release artifact (CJS+ESM) : active, 39s section Git release - Bump package version : active, 8s - Package release : active, 8s - Git Tag : active, 8s - Push Tag : active, 8s + Git Tag : active, 8s + Push Tag : active, 8s section Release - Attest build : active, 8s - Sign attestation : active, attestation, 10:06, 8s - Publish npm.js : active, npm, after attestation, 29s + Attest build : active, 8s + Sign attestation : active, attestation, 10:04, 8s + Publish npm.js : active, npm, after attestation, 40s -npmjs.com release : milestone, m2, 10:06,1s +npmjs.com release : milestone, m2 section Layer release - Build : active, layer_build, 10:08, 6m - Deploy Beta : active, layer_beta, after layer_build, 4.3m - Run Canary Test : active, layer_canary, after layer_beta, 1.4m - Deploy Prod : active, layer_prod, after layer_canary, 4.3m + Build : active, layer_build, 10:05, 2.5m + Deploy Beta : active, layer_beta, after layer_build, 4m + Run Canary Test : active, layer_canary, after layer_beta, 2m + Deploy Prod : active, layer_prod, after layer_canary, 4m -Layer release : milestone, m3, 10:24,1s +Layer release : milestone, m3 section Docs - Create commit (Layer ARN) : active, 10:24, 8s - Release versioned docs : active, 2.4m + Create commit (Layer ARN) : active, 10:18, 8s + Review & merge PR : active, 8s + Publish updated docs : active, 2m -Documentation release : milestone, m4, 10:26,1m +Documentation release : milestone, m4 -Release complete : milestone, m5, 10:26, 2m +Release complete : milestone, m5 ``` #### Drafting release notes From 2855a3e83af5446ca7e62598a9c304644e11c070 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Tue, 9 Apr 2024 06:36:26 +0000 Subject: [PATCH 2/2] docs: update diagram & wording --- docs/maintainers.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/maintainers.md b/docs/maintainers.md index e9dc3b1f1e..672e93a92b 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -174,7 +174,7 @@ Once complete, you can start drafting the release notes to let customers know ** #### Release process visualized -Every release makes dozens of checks, linting, canaries and deployments - all of these are automated. +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. 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. @@ -192,7 +192,9 @@ Release start : milestone, m1, 10:00, 8s section Version Bump package version : active, 8s Create commit (version bump) : active, 8s - Review & merge PR : active, 8s + Open version PR : active, 8s + +Review and merge version PR : milestone, m2 section QA Quality checks : active, 2.4m @@ -209,7 +211,7 @@ section Release Sign attestation : active, attestation, 10:04, 8s Publish npm.js : active, npm, after attestation, 40s -npmjs.com release : milestone, m2 +npmjs.com release : milestone, m3 section Layer release Build : active, layer_build, 10:05, 2.5m @@ -217,16 +219,19 @@ section Layer release Run Canary Test : active, layer_canary, after layer_beta, 2m Deploy Prod : active, layer_prod, after layer_canary, 4m -Layer release : milestone, m3 +Layer release : milestone, m4 section Docs Create commit (Layer ARN) : active, 10:18, 8s - Review & merge PR : active, 8s + Open docs PR : active, 8s + +Review andmerge docs PR : milestone, m5 + Publish updated docs : active, 2m -Documentation release : milestone, m4 +Documentation release : milestone, m6 -Release complete : milestone, m5 +Release complete : milestone, m7 ``` #### Drafting release notes