From adb6db438ce0baa0714cc4880bc2611a05172e92 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 28 Oct 2024 11:12:36 +0100 Subject: [PATCH 1/4] BCD upgrade checklist: Avoid creating an issue back reference This will happen on *every* upgrade PR, which isn't great. Using a relative link avoid this, reportedly. https://github.com/orgs/community/discussions/23123#discussioncomment-10789744 --- .github/workflows/bcd_upgrade_checklist.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/bcd_upgrade_checklist.yml b/.github/workflows/bcd_upgrade_checklist.yml index 97592f990ad..4a38f520165 100644 --- a/.github/workflows/bcd_upgrade_checklist.yml +++ b/.github/workflows/bcd_upgrade_checklist.yml @@ -27,7 +27,7 @@ jobs: - [ ] Check out this branch locally. - [ ] If any keys were removed in the release, delete them from `.yml` files. - [ ] Run `npm install && npm run dist && npm test && git commit --all --message="Refresh dist"`. - - [ ] Review the diff. Watch out for Baseline regressions; if applicable, add a comment (see https://github.com/web-platform-dx/web-features/issues/1971). + - [ ] Review the diff. Watch out for Baseline regressions; if applicable, add a comment (see [#1971](/web-platform-dx/web-features/issues/1971)). - [ ] Start a PR to [publish the next web-features release](https://github.com/web-platform-dx/web-features/blob/main/docs/publishing.md#regular-releases). - [ ] Merge this PR. - [ ] [Trigger a drafts update workflow run](https://github.com/web-platform-dx/web-features/actions/workflows/update_draft_features_weekly.yml). From bc5a4d041767c4e868aefd0b1953ce09f61555aa Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 28 Oct 2024 11:13:26 +0100 Subject: [PATCH 2/4] BCD upgrade checklist: be specific about commits and pushes --- .github/workflows/bcd_upgrade_checklist.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/bcd_upgrade_checklist.yml b/.github/workflows/bcd_upgrade_checklist.yml index 4a38f520165..04fa680525a 100644 --- a/.github/workflows/bcd_upgrade_checklist.yml +++ b/.github/workflows/bcd_upgrade_checklist.yml @@ -25,8 +25,8 @@ jobs: Complete this checklist for every `@mdn/browser-compat-data` upgrade PR: - [ ] Check out this branch locally. - - [ ] If any keys were removed in the release, delete them from `.yml` files. - - [ ] Run `npm install && npm run dist && npm test && git commit --all --message="Refresh dist"`. + - [ ] If any keys were removed in the release, delete them from `.yml` files and commit your changes. + - [ ] Run `npm install && npm run dist && npm test && git commit --all --message="Refresh dist" && git push`. - [ ] Review the diff. Watch out for Baseline regressions; if applicable, add a comment (see [#1971](/web-platform-dx/web-features/issues/1971)). - [ ] Start a PR to [publish the next web-features release](https://github.com/web-platform-dx/web-features/blob/main/docs/publishing.md#regular-releases). - [ ] Merge this PR. From cd2023d335652810f5c55736350b51e059ec3f5d Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 28 Oct 2024 11:17:25 +0100 Subject: [PATCH 3/4] BCD upgrade checklist: change order of steps The original order implied that a release ought to happen before BCD is upgraded. --- .github/workflows/bcd_upgrade_checklist.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/bcd_upgrade_checklist.yml b/.github/workflows/bcd_upgrade_checklist.yml index 04fa680525a..44aec78adaa 100644 --- a/.github/workflows/bcd_upgrade_checklist.yml +++ b/.github/workflows/bcd_upgrade_checklist.yml @@ -28,6 +28,6 @@ jobs: - [ ] If any keys were removed in the release, delete them from `.yml` files and commit your changes. - [ ] Run `npm install && npm run dist && npm test && git commit --all --message="Refresh dist" && git push`. - [ ] Review the diff. Watch out for Baseline regressions; if applicable, add a comment (see [#1971](/web-platform-dx/web-features/issues/1971)). - - [ ] Start a PR to [publish the next web-features release](https://github.com/web-platform-dx/web-features/blob/main/docs/publishing.md#regular-releases). - [ ] Merge this PR. + - [ ] Start a PR to [publish the next web-features release](https://github.com/web-platform-dx/web-features/blob/main/docs/publishing.md#regular-releases). - [ ] [Trigger a drafts update workflow run](https://github.com/web-platform-dx/web-features/actions/workflows/update_draft_features_weekly.yml). From ebcb65b63a870bc5c237dcf3f38b0cb40de443e0 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 28 Oct 2024 11:25:01 +0100 Subject: [PATCH 4/4] BCD upgrade checklist: group steps for before and after merging --- .github/workflows/bcd_upgrade_checklist.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/bcd_upgrade_checklist.yml b/.github/workflows/bcd_upgrade_checklist.yml index 44aec78adaa..c1b4ec23e51 100644 --- a/.github/workflows/bcd_upgrade_checklist.yml +++ b/.github/workflows/bcd_upgrade_checklist.yml @@ -22,12 +22,15 @@ jobs: with: issue-number: ${{ github.event.number }} body: | - Complete this checklist for every `@mdn/browser-compat-data` upgrade PR: + Complete this checklist for every `@mdn/browser-compat-data` upgrade PR. - [ ] Check out this branch locally. - [ ] If any keys were removed in the release, delete them from `.yml` files and commit your changes. - [ ] Run `npm install && npm run dist && npm test && git commit --all --message="Refresh dist" && git push`. - [ ] Review the diff. Watch out for Baseline regressions; if applicable, add a comment (see [#1971](/web-platform-dx/web-features/issues/1971)). - [ ] Merge this PR. + + After merging, do these steps: + - [ ] Start a PR to [publish the next web-features release](https://github.com/web-platform-dx/web-features/blob/main/docs/publishing.md#regular-releases). - [ ] [Trigger a drafts update workflow run](https://github.com/web-platform-dx/web-features/actions/workflows/update_draft_features_weekly.yml).