Skip to content

Commit 661d769

Browse files
committed
Update release instructions: version-only title for GitHub releases
1 parent 691c508 commit 661d769

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ src/quantecon_book_theme/
118118
2. Run: `gh pr edit 123 --body-file /tmp/pr_body.md`
119119
- Example workflow for creating a release:
120120
1. Use `create_file` to write release notes to `/tmp/release_notes.md`
121-
2. Run: `gh release create vX.Y.Z --title "Title" --notes-file /tmp/release_notes.md`
121+
2. Run: `gh release create vX.Y.Z --title "vX.Y.Z" --notes-file /tmp/release_notes.md`
122122
- **Output Capture**: Always write gh output to `/tmp` file for reliable capture: `gh pr view 123 2>&1 | tee /tmp/gh_output.txt`
123123

124124
### Missing Python 3.13
@@ -268,13 +268,14 @@ git push && git push origin vX.Y.Z
268268
### 5. Create GitHub Release
269269
```bash
270270
# Write release notes to a temp file first (use create_file tool)
271+
# Release notes should start with a descriptive heading: # Descriptive Release Title
271272
# Then create the release using --notes-file
272273
gh release create vX.Y.Z \
273-
--title "vX.Y.Z - Release Title" \
274+
--title "vX.Y.Z" \
274275
--notes-file /tmp/release_notes.md
275276
```
276277

277-
**IMPORTANT**: Always use `--notes-file` with a temp file instead of `--notes` to avoid zsh shell escaping issues. Creating the GitHub release triggers the PyPI publish workflow automatically.
278+
**IMPORTANT**: The GitHub release title should be the version only (e.g. `v0.20.0`). Put the descriptive title as an `# H1` heading at the top of the release notes file instead.
278279

279280
### 6. Verify PyPI Publication
280281
- Check GitHub Actions for successful PyPI publish workflow

0 commit comments

Comments
 (0)