Skip to content

Commit c96a5ff

Browse files
authored
ci: document the deploy pipeline in the build Step Summary (#6)
Add a Pipeline section (build -> pin dev -> promote prod) and split the per-function block into an explicit dev-pin snippet + the prod promote command. Generic/public-safe (promotion target stays caller-supplied). Workflow-only; @v0 moves, no PyPI re-release.
1 parent 4fadb30 commit c96a5ff

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

.github/workflows/build.yml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,18 +157,30 @@ jobs:
157157
out.append(
158158
f"| `{r['logical_name']}` | {r['outcome']} | `{r['sha256']}` | `{r['bucket_key']}` |"
159159
)
160-
out += ["", "### Promote to prod", ""]
160+
out += [
161+
"",
162+
"### Pipeline",
163+
"",
164+
"1. **Build** (this run) - artifacts uploaded to the dev bucket, keyed by content sha.",
165+
"2. **Pin dev** - point the dev stack's lambda pin at the sha below, then apply dev and test.",
166+
"3. **Promote to prod** - run the promote command below (copies dev -> prod by content"
167+
" sha + opens the prod-pin PR), then apply prod.",
168+
"",
169+
"### Per-function",
170+
"",
171+
]
161172
for r in rows:
162173
fn, sha = r["logical_name"], r["sha256"]
163-
out += [f"**`{fn}`** prod pin: `{fn} = \"{sha}\"`", ""]
174+
out += [f"**`{fn}`** - content sha `{sha}`", "", f"- dev pin: `{fn} = \"{sha}\"`"]
164175
if repo:
165176
out += [
177+
"- promote to prod:",
166178
"```bash",
167179
f"gh workflow run {wf} --repo {repo} "
168180
f"-f project={project} -f function={fn} -f sha={sha}",
169181
"```",
170-
"",
171182
]
183+
out += [""]
172184
173185
with open(os.environ["GITHUB_STEP_SUMMARY"], "a") as f:
174186
f.write("\n".join(out) + "\n")

0 commit comments

Comments
 (0)