Skip to content

Commit 2a632af

Browse files
committed
add release notes flow to RELEASING.md
1 parent 129e6a7 commit 2a632af

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/RELEASING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@
2222

2323
No rebuild happens on merge. All artifacts are reused from the pre-release.
2424

25+
## Release notes
26+
27+
The PR body is used as release notes throughout the pipeline:
28+
29+
1. The `prerelease` job takes the PR body and passes it as `--notes` to `gh release create`
30+
2. When the PR is merged, the `release` job reads the body from the pre-release via `gh release view` and copies it into the final release via `--notes-file`
31+
32+
**PR body -> pre-release notes -> release notes.** Write the changelog in the PR description.
33+
2534
## Fork builds
2635

2736
A separate `fork-release.yaml` workflow handles forks. When `private-build-plans.toml` changes on `main` in a forked repo, it automatically builds the font and publishes a `latest` pre-release.

0 commit comments

Comments
 (0)