Skip to content

Commit a56fecc

Browse files
committed
docs: update release notes step to use --notes-file
1 parent 4cd2849 commit a56fecc

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

RELEASE.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,23 @@
5555

5656
<!-- END-SHARED -->
5757

58-
7. Update the release notes on GitHub to match CHANGELOG.md:
58+
7. Update the release notes on GitHub to match `CHANGELOG.md`:
59+
60+
Write the notes in Markdown format to a temp file, then pass it via `--notes-file`:
5961

6062
```sh
61-
gh release edit vX.Y.Z --notes "## Improved
63+
gh release edit vX.Y.Z --notes-file /path/to/notes.md
64+
```
65+
66+
Notes format:
67+
68+
```markdown
69+
## What's Changed
70+
71+
### Added/Changed/Fixed
72+
6273
- Change 1
6374
- Change 2
6475

65-
**Full Changelog**: https://github.com/euxx/github-notifier-pro/compare/vPREV...vX.Y.Z"
76+
**Full Changelog**: https://github.com/euxx/github-notifier-pro/compare/vPREV...vX.Y.Z
6677
```

0 commit comments

Comments
 (0)