From b247947db8a321f4b5f275b3561bcc9bfd005b78 Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 17:54:48 +0000 Subject: [PATCH 1/8] Add workflow for pull request specific checks Job that verifies the description checklist items are completed or invalid Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 24 +++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/pull-request-checks.yml diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml new file mode 100644 index 0000000000000..ba95c0e2a6337 --- /dev/null +++ b/.github/workflows/pull-request-checks.yml @@ -0,0 +1,24 @@ +name: Pull Request Checks + +on: + pull_request: + types: + - opened + - edited + - reopened + +jobs: + verify-description: + name: Verify Description + runs-on: ubuntu-latest + steps: + - uses: peternied/check-pull-request-description@main + with: + checklistItems: | + New functionality includes testing. + All tests pass + New functionality has been documented. + New functionality has javadoc added + Commits are signed per the DCO using --signoff + Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog)) + \ No newline at end of file From c3762117e0bb58903cfa97fe7d92bbcfdb0ef47b Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:05:19 +0000 Subject: [PATCH 2/8] Fix incorrect parameter Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index ba95c0e2a6337..150268191e98e 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -14,7 +14,7 @@ jobs: steps: - uses: peternied/check-pull-request-description@main with: - checklistItems: | + checklist-items: | New functionality includes testing. All tests pass New functionality has been documented. From bd9a6da3ea160ee859119f025e7d674c6930b484 Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:10:01 +0000 Subject: [PATCH 3/8] Don't limit pull request trigger types Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 150268191e98e..839735d04a6b9 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -2,10 +2,6 @@ name: Pull Request Checks on: pull_request: - types: - - opened - - edited - - reopened jobs: verify-description: @@ -14,11 +10,13 @@ jobs: steps: - uses: peternied/check-pull-request-description@main with: - checklist-items: | + checklist-tems: | New functionality includes testing. All tests pass New functionality has been documented. New functionality has javadoc added Commits are signed per the DCO using --signoff Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog)) + + \ No newline at end of file From 2aed037714a6ba381a7cffc3c92a87f242089be8 Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:11:10 +0000 Subject: [PATCH 4/8] Add that missing 'i' Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 839735d04a6b9..e3707a142eba9 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -10,7 +10,7 @@ jobs: steps: - uses: peternied/check-pull-request-description@main with: - checklist-tems: | + checklist-items: | New functionality includes testing. All tests pass New functionality has been documented. From 0219b4637cea6e4d01cf390a4f19557e5da4f32c Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:23:52 +0000 Subject: [PATCH 5/8] Small whitespace change Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index e3707a142eba9..11d6ab3687826 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -17,6 +17,4 @@ jobs: New functionality has javadoc added Commits are signed per the DCO using --signoff Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog)) - - \ No newline at end of file From c212a8b583133a88a23293388ad9a13c98e49e1d Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:25:52 +0000 Subject: [PATCH 6/8] Update triggers for the pull request checks Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 11d6ab3687826..0d078533b6357 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -2,6 +2,7 @@ name: Pull Request Checks on: pull_request: + types: [opened, edited, review_requested, synchronize, reopened, ready_for_review] jobs: verify-description: From ce61acbee4daeaf35c5901fdb9970a35dc16864d Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Fri, 20 Oct 2023 18:26:33 +0000 Subject: [PATCH 7/8] Format document Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 29 ++++++++++++++--------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 0d078533b6357..8570fc20f8dad 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -2,20 +2,27 @@ name: Pull Request Checks on: pull_request: - types: [opened, edited, review_requested, synchronize, reopened, ready_for_review] + types: + [ + opened, + edited, + review_requested, + synchronize, + reopened, + ready_for_review, + ] jobs: verify-description: name: Verify Description runs-on: ubuntu-latest steps: - - uses: peternied/check-pull-request-description@main - with: - checklist-items: | - New functionality includes testing. - All tests pass - New functionality has been documented. - New functionality has javadoc added - Commits are signed per the DCO using --signoff - Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog)) - + - uses: peternied/check-pull-request-description@main + with: + checklist-items: | + New functionality includes testing. + All tests pass + New functionality has been documented. + New functionality has javadoc added + Commits are signed per the DCO using --signoff + Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../blob/main/CONTRIBUTING.md#changelog)) From 158d0bdd554435df7e5442f3fcaab802d971e014 Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Mon, 23 Oct 2023 21:29:19 +0000 Subject: [PATCH 8/8] Ready for merging Signed-off-by: Peter Nied --- .github/workflows/pull-request-checks.yml | 6 +++--- CHANGELOG.md | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/pull-request-checks.yml b/.github/workflows/pull-request-checks.yml index 8570fc20f8dad..11998e36c2dbb 100644 --- a/.github/workflows/pull-request-checks.yml +++ b/.github/workflows/pull-request-checks.yml @@ -13,11 +13,11 @@ on: ] jobs: - verify-description: - name: Verify Description + verify-description-checklist: + name: Verify Description Checklist runs-on: ubuntu-latest steps: - - uses: peternied/check-pull-request-description@main + - uses: peternied/check-pull-request-description-checklist@v1 with: checklist-items: | New functionality includes testing. diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c4563a216974..6a0825341b9c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - [Remote cluster state] Download functionality of global metadata from remote store ([#10535](https://github.com/opensearch-project/OpenSearch/pull/10535)) - [Remote cluster state] Restore global metadata from remote store when local state is lost after quorum loss ([#10404](https://github.com/opensearch-project/OpenSearch/pull/10404)) - [AdmissionControl] Added changes for AdmissionControl Interceptor and AdmissionControlService for RateLimiting ([#9286](https://github.com/opensearch-project/OpenSearch/pull/9286)) +- GHA to verify checklist items completion in PR descriptions ([#10800](https://github.com/opensearch-project/OpenSearch/pull/10800)) ### Dependencies - Bump `log4j-core` from 2.18.0 to 2.19.0