Skip to content

Commit 44b4faa

Browse files
committed
chore: add step numbers to release workflow headers
1 parent d2af60a commit 44b4faa

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

.github/workflows/release-cherry-pick.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Cherry-picks a commit from main to the release/candidate branch.
2-
# Use this to include bug fixes in an in-progress release.
1+
# Step 3 (optional): Cherry-picks a commit from main to the release/candidate branch.
2+
# Use between step 1 and step 4 to include bug fixes in an in-progress release.
33
name: "Release: Cherry-pick"
44

55
on:

.github/workflows/release-cut.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Starts the release process by creating a release/candidate branch.
2-
# Triggers release-please to generate a changelog PR.
1+
# Step 1: Starts the release process by creating a release/candidate branch.
2+
# Generates a changelog PR for review (step 2).
33
name: "Release: Cut"
44

55
on:

.github/workflows/release-finalize.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Triggers when release-please PR is merged to release/candidate.
2-
# Renames release/candidate to release/v{version}.
1+
# Step 4: Triggers when the changelog PR is merged to release/candidate.
2+
# Records last-release-sha and renames release/candidate to release/v{version}.
33
name: "Release: Finalize"
44

55
on:

.github/workflows/release-please.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Runs release-please to create/update a PR with version bump and changelog.
2-
# Triggered by pushes to release/candidate or manually.
2+
# Triggered automatically by step 1 (cut) or step 3 (cherry-pick).
33
name: "Release: Please"
44

55
on:

.github/workflows/release-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Builds and publishes the package to PyPI from a release branch.
2-
# Creates a merge-back PR to sync release changes to main.
1+
# Step 6: Builds and publishes the package to PyPI from a release/v{version} branch.
2+
# Creates a merge-back PR (step 7) to sync release changes to main.
33
name: "Release: Publish to PyPi"
44

55
on:

0 commit comments

Comments
 (0)