Skip to content

Commit 7e72a66

Browse files
authored
docs: clarify release process instructions (#1002)
1 parent f87f7e3 commit 7e72a66

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,17 +126,19 @@ gh release view v<VERSION> --json body,name,tagName,targetCommitish
126126
#### 2. Publish the Release
127127

128128
```bash
129-
# Get the release ID from the list above
129+
# Identify the draft release tag from the list above (e.g., v0.17.0)
130130
gh release list | grep "Draft"
131131

132132
# Publish using the workflow (recommended)
133-
gh workflow run publish-release.yml -f release_id=<RELEASE_ID>
133+
# Note: release_id expects the tag name, not a numeric ID
134+
gh workflow run publish-release.yml -f release_id=v0.17.0
134135
```
135136

136137
**OR** publish directly:
137138

138139
```bash
139-
gh release edit <RELEASE_ID> --draft=false
140+
# Use the tag name (e.g., v0.17.0), not the numeric release ID
141+
gh release edit v0.17.0 --draft=false
140142
```
141143

142144
#### 3. Handle Version Bump PR
@@ -162,8 +164,8 @@ git tag --points-at HEAD # Should show the new version tag
162164

163165
### Deployment
164166

165-
Production deployment happens automatically when changes are merged to the `prod` branch. To deploy a release:
167+
Production deployment happens automatically when changes are merged to the `production` branch. To deploy a release:
166168

167169
1. Merge the release version bump PR to `main`
168-
2. Create a PR from `main` to `prod`
169-
3. Once merged to `prod`, the deployment workflow automatically builds and deploys to production
170+
2. Create a PR from `main` to `production` (or merge directly)
171+
3. Once merged to `production`, the deployment workflow automatically builds and deploys to production

0 commit comments

Comments
 (0)