From 08045d950b86cf2fdeb03f016d6246d31a52743c Mon Sep 17 00:00:00 2001 From: David Cook Date: Tue, 11 Mar 2025 15:51:28 +1100 Subject: [PATCH 1/4] Categorise breaking-change labels in release notes --- .github/release.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/release.yml b/.github/release.yml index 5f9b85166d..084481bfda 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -14,6 +14,12 @@ changelog: - technical changes only - user facing changes + # These will require a minor or major version increment + - title: "Breaking changes" + labels: + - breaking-change + - major-breaking-change + # Posted in advance for #instance-managers - title: "User-facing changes 👀" labels: From bd6f718befbe2a9036e285616889a05ff0f212f4 Mon Sep 17 00:00:00 2001 From: David Cook Date: Tue, 11 Mar 2025 15:58:23 +1100 Subject: [PATCH 2/4] Add reminder to check for breaking changes [skip ci] --- .github/ISSUE_TEMPLATE/release.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 9e4a0fc526..8bf20f023a 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -13,6 +13,7 @@ assignees: '' - [ ] Include translations: `script/release/update_locales` - You need the [Transifex Client] installed on your local dev environement to run the script. - [ ] Increment version number: `git push upstream HEAD:refs/tags/vX.Y.Z` + Check for [minor or major breaking changes](https://github.com/openfoodfoundation/openfoodnetwork/pulls?q=label%3Abreaking-change%2Cmajor-breaking-change) - Major: if server changes are required (eg. provision with ofn-install) - Minor: larger change that is irreversible (eg. migration deleting data) - Patch: all others. Shortcut: `script/release/tag` From 1d55c234a4eb601a8f7f1f6d25946c2cb38b6f52 Mon Sep 17 00:00:00 2001 From: David Cook Date: Thu, 20 Mar 2025 15:18:57 +1100 Subject: [PATCH 3/4] Rename release category title Much less alarming than 'breaking'. --- .github/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/release.yml b/.github/release.yml index 084481bfda..2b6ac1f004 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -15,7 +15,7 @@ changelog: - user facing changes # These will require a minor or major version increment - - title: "Breaking changes" + - title: "Significant changes 🚀" labels: - breaking-change - major-breaking-change From da3bd4eae9b3aa7a0af639ee72cfd7010354a1ac Mon Sep 17 00:00:00 2001 From: David Cook Date: Thu, 20 Mar 2025 15:19:43 +1100 Subject: [PATCH 4/4] Use spaces in label names The labels on GitHub have already been updated. [skip ci] --- .github/ISSUE_TEMPLATE/release.md | 3 ++- .github/release.yml | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 8bf20f023a..f652057116 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -13,7 +13,7 @@ assignees: '' - [ ] Include translations: `script/release/update_locales` - You need the [Transifex Client] installed on your local dev environement to run the script. - [ ] Increment version number: `git push upstream HEAD:refs/tags/vX.Y.Z` - Check for [minor or major breaking changes](https://github.com/openfoodfoundation/openfoodnetwork/pulls?q=label%3Abreaking-change%2Cmajor-breaking-change) + Check for [minor or major breaking changes] - Major: if server changes are required (eg. provision with ofn-install) - Minor: larger change that is irreversible (eg. migration deleting data) - Patch: all others. Shortcut: `script/release/tag` @@ -57,3 +57,4 @@ The full process is described at https://github.com/openfoodfoundation/openfoodn [Create issue]: https://github.com/openfoodfoundation/openfoodnetwork/issues/new?assignees=&labels=&projects=&template=release.md&title=Release [#delivery-circle]: https://openfoodnetwork.slack.com/archives/C01T75H6G0Z [Transifex Client]: https://developers.transifex.com/docs/cli +[minor or major breaking changes]: https://github.com/openfoodfoundation/openfoodnetwork/pulls?q=label%3A%22breaking+change%22%2C%22major+breaking+change%22 \ No newline at end of file diff --git a/.github/release.yml b/.github/release.yml index 2b6ac1f004..218b3d49f3 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -17,8 +17,8 @@ changelog: # These will require a minor or major version increment - title: "Significant changes 🚀" labels: - - breaking-change - - major-breaking-change + - breaking change + - major breaking change # Posted in advance for #instance-managers - title: "User-facing changes 👀"