@@ -62,7 +62,7 @@ or clicks "squash and merge" on github
6262
6363** what happens:**
6464- changes merge to main branch
65- - ** no ci workflow runs** (ci only runs on PRs)
65+ - ** no ci workflow runs** (ci only runs on PRs, not pushes to main )
6666- ** no version changes**
6767- ** no release created**
6868- ** no pr created**
@@ -92,7 +92,7 @@ or: github ui → actions → "prepare release" → run workflow → choose patc
9292 - ` .release-please-manifest.json ` - sets cli to "0.3.0"
9393 - ` cli/CHANGELOG.md ` - adds section with commits
9494 - creates PR with title "release 0.3.0"
95- - ** ci workflow triggers** on the release PR
95+ - ** ci workflow triggers** on the release PR (validates all merged changes work together)
9696 - runs all 6 checks (preflight, tests, lint, build)
9797
9898---
@@ -121,7 +121,6 @@ gh workflow run release.yml -f version=0.3.0
121121```
122122or: github ui → actions → "release" → run workflow → enter version number
123123
124- ** what happens:**
125124** what happens:**
126125- ** release workflow runs** (` release.yml ` )
127126 - checks out main branch
@@ -139,6 +138,7 @@ or: github ui → actions → "release" → run workflow → enter version numbe
139138 - uses changelog from ` cli/CHANGELOG.md ` for release notes
140139 - updates ` registry.json ` with ` azd x publish `
141140 - commits and pushes registry.json to main
141+
142142** result:**
143143- github release v0.3.0 exists with binaries
144144- users can download/install the release
@@ -147,15 +147,15 @@ or: github ui → actions → "release" → run workflow → enter version numbe
147147---
148148
149149## summary table
150+
150151| step | user action | workflow | creates pr? | creates release? |
151152| ------| -------------| ----------| -------------| ------------------|
152153| 1-2 | create branch, commit | none | no | no |
153- | 3 | create pr | ci runs | no | no |
154+ | 3 | create pr | ci runs on pr | no | no |
154155| 4 | merge pr | none | no | no |
155- | 5a | run "prepare release" | prepare release + ci | yes (release pr) | no |
156+ | 5a | run "prepare release" | prepare release + ci on release pr | yes (release pr) | no |
156157| 5b | merge release pr | none | no | no |
157- | 5c | run "release" | release | no | yes (with binaries) |
158- | 5c | run "release" | release | no | yes (with binaries) |
158+ | 5c | run "release" | release workflow | no | yes (with binaries) |
159159
160160** key insight:** merging regular prs does nothing special. only the admin manually triggers release preparation and publishing.
161161
@@ -250,11 +250,11 @@ or: github ui → actions → "release" → run workflow → enter version numbe
250250 - upload all binaries as release assets
251251- updates registry.json with azd x publish
252252- pushes registry.json back to main
253+
253254** result:**
254255- github release created with binaries
255256- users can download/install the new version
256- - registry updated with new versionversion
257- - registry updated (if azd available)
257+ - registry updated with new version
258258
259259---
260260
0 commit comments