Skip to content

Add structured release notes template #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markmur wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add structured release notes template #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
380896c
Add structured release notes template
markmur Aug 13, 2026
4b430d7
Use British spelling for behaviour
markmur Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,15 @@ Shopify employees get this through `dev up`. External contributors can copy
`.env.example` to `.env`, fill in local storefront values, then run
`scripts/setup_storefront_env` from the repo root.

## Release notes

The Release package workflow prepends `.github/RELEASE_TEMPLATE.md` to GitHub's
generated release notes. Before publishing a draft release, complete the
breaking, additive, and behaviour change sections, including focused code diffs
where they help consumers understand the change or migrate. Keep `None.` for
sections that do not apply. The generated list of included pull requests and
contributors remains below the curated sections.

---

## Swift (`platforms/swift/`)
Expand Down
29 changes: 29 additions & 0 deletions .github/RELEASE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Breaking changes

<!--
List consumer-facing breaking changes first. For each change, explain the
migration and include a focused before/after code diff. Replace "None." when
breaking changes are present.
-->

None.

## Additive changes

<!--
List new APIs and capabilities that do not require consumer migration. Include
focused code examples or diffs where they help consumers adopt the change.
Replace "None." when additive changes are present.
-->

None.

## Behaviour changes

<!--
List other consumer-visible behaviour changes, fixes, and deprecations. Include
focused code examples or diffs where useful. Replace "None." when behaviour
changes are present.
-->

None.
9 changes: 8 additions & 1 deletion .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,14 @@ jobs:
run: |
set -euo pipefail

args=("$TAG" --target "$GITHUB_SHA" --title "$RELEASE_TITLE" --generate-notes)
RELEASE_NOTES_TEMPLATE="$(cat .github/RELEASE_TEMPLATE.md)"
args=(
"$TAG"
--target "$GITHUB_SHA"
--title "$RELEASE_TITLE"
--notes "$RELEASE_NOTES_TEMPLATE"
--generate-notes
)
if [ "$DRAFT" = "true" ]; then
args+=(--draft)
fi
Expand Down
Loading