From 380896c78283fe1b056709c1e4f983733ba7297f Mon Sep 17 00:00:00 2001 From: Mark Murray Date: Thu, 13 Aug 2026 15:59:04 +0100 Subject: [PATCH 1/2] Add structured release notes template --- .github/CONTRIBUTING.md | 9 +++++++++ .github/RELEASE_TEMPLATE.md | 29 +++++++++++++++++++++++++++++ .github/workflows/release.yml | 9 ++++++++- 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 .github/RELEASE_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d19e7c1c6..85fe98d32 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 behavior 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/`) diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md new file mode 100644 index 000000000..20e767e65 --- /dev/null +++ b/.github/RELEASE_TEMPLATE.md @@ -0,0 +1,29 @@ +## Breaking changes + + + +None. + +## Additive changes + + + +None. + +## Behavior changes + + + +None. diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1d4cecc0c..b95f2e29d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -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 From 4b430d7424ab8b372dd9b1942799dd9c6da3eb9a Mon Sep 17 00:00:00 2001 From: Mark Murray Date: Thu, 13 Aug 2026 16:00:51 +0100 Subject: [PATCH 2/2] Use British spelling for behaviour --- .github/CONTRIBUTING.md | 2 +- .github/RELEASE_TEMPLATE.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 85fe98d32..d375a57c5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -142,7 +142,7 @@ Shopify employees get this through `dev up`. External contributors can copy 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 behavior change sections, including focused code diffs +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. diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md index 20e767e65..e1b10be0e 100644 --- a/.github/RELEASE_TEMPLATE.md +++ b/.github/RELEASE_TEMPLATE.md @@ -18,11 +18,11 @@ Replace "None." when additive changes are present. None. -## Behavior changes +## Behaviour changes