From 1184414b392c45ea77626c402c0494a66d08d0f3 Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Wed, 25 Sep 2024 14:57:14 -0700 Subject: [PATCH 1/8] PR template standardized with changes to Chromatic PR template --- .github/PULL_REQUEST_TEMPLATE.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9b3dc6e9..9b8a13c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,25 @@ Issue: # -## What Changed +## Summary - + -## How to test +## How to QA - + + +1. + +Check ☑️ the appropriate box once you've finished QA: + +- [ ] Author - QA OK +- [ ] Reviewer - QA OK From aa6d368c8e155fa088854c051c65d171eae9884e Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Wed, 25 Sep 2024 15:03:37 -0700 Subject: [PATCH 2/8] Make sure we include changeset if releasing --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9b8a13c8..04344432 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,3 +23,14 @@ Check ☑️ the appropriate box once you've finished QA: - [ ] Author - QA OK - [ ] Reviewer - QA OK + + + + + + From ce6fff9dd81e675bee4580c7a2523506f2a68754 Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Wed, 25 Sep 2024 15:04:29 -0700 Subject: [PATCH 3/8] Actual link --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 04344432..96ef8f55 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -28,7 +28,7 @@ Check ☑️ the appropriate box once you've finished QA: From b5c402354c83e1a9185627723418d02caf34b130 Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Wed, 25 Sep 2024 15:05:29 -0700 Subject: [PATCH 4/8] Changeset, not checklist :facepalm --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 96ef8f55..5252570b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -28,7 +28,7 @@ Check ☑️ the appropriate box once you've finished QA: From f0f769aba1563bbd23ffeac5969690ac05152a2b Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Wed, 25 Sep 2024 15:07:51 -0700 Subject: [PATCH 5/8] Whitespace removed --- .github/PULL_REQUEST_TEMPLATE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5252570b..5b05ba04 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -30,7 +30,6 @@ Check ☑️ the appropriate box once you've finished QA: ## Release checklist - [ ] [Changeset](https://github.com/chromaui/chromatic-e2e/blob/main/DEVELOPMENT.md#pr-workflow-with-changesets) created in this PR - --> From 4b060be050a1f2b2110e9c4a5701b4bbf01253c4 Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Thu, 26 Sep 2024 10:34:33 -0700 Subject: [PATCH 6/8] Require checkboxes to be, well, checked before merging --- .github/workflows/checklist.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/checklist.yml diff --git a/.github/workflows/checklist.yml b/.github/workflows/checklist.yml new file mode 100644 index 00000000..a2367dd3 --- /dev/null +++ b/.github/workflows/checklist.yml @@ -0,0 +1,28 @@ +name: Checking PR checklist +on: + pull_request: + types: [opened, edited, synchronize] + +jobs: + check-pr-description: + runs-on: ubuntu-latest + steps: + - id: task-completed + uses: chromaui/task-completed-checker-action@main + with: + repo-token: '${{ secrets.GITHUB_TOKEN }}' + continue-on-error: true + - name: Update Check (failure) + if: steps.task-completed.outcome != 'success' + uses: ouzi-dev/commit-status-updater@v2 + with: + name: PR Checklist + status: pending + description: Check off PR items to proceed + - name: Update Check (success) + if: steps.task-completed.outcome == 'success' + uses: ouzi-dev/commit-status-updater@v2 + with: + name: PR Checklist + status: success + description: All tasks checked off! From 4557c602731abfeb9592d0b92844be1debea73c1 Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Thu, 26 Sep 2024 11:51:12 -0700 Subject: [PATCH 7/8] Read-all permissions for checklist check --- .github/workflows/checklist.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/checklist.yml b/.github/workflows/checklist.yml index a2367dd3..218d21ae 100644 --- a/.github/workflows/checklist.yml +++ b/.github/workflows/checklist.yml @@ -1,4 +1,5 @@ name: Checking PR checklist +permissions: read-all on: pull_request: types: [opened, edited, synchronize] From 6f92554667ca2930cf6a825c433c9314cc851fce Mon Sep 17 00:00:00 2001 From: Steven Kitterman Date: Fri, 27 Sep 2024 07:42:17 -0700 Subject: [PATCH 8/8] Comment-in the changeset section as we typically publish to NPM when making changes --- .github/PULL_REQUEST_TEMPLATE.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5b05ba04..8e6aebc0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -24,12 +24,10 @@ Check ☑️ the appropriate box once you've finished QA: - [ ] Author - QA OK - [ ] Reviewer - QA OK - - - - +- [ ] [Changeset](https://github.com/chromaui/chromatic-e2e/blob/main/DEVELOPMENT.md#pr-workflow-with-changesets) created in this PR