diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d19e7c1c6..d375a57c5 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 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/`) diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md new file mode 100644 index 000000000..e1b10be0e --- /dev/null +++ b/.github/RELEASE_TEMPLATE.md @@ -0,0 +1,29 @@ +## Breaking changes + + + +None. + +## Additive changes + + + +None. + +## Behaviour 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