From 714608de0d34779dc43937d85a0d85ffb8f06a22 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 06:43:16 -0500 Subject: [PATCH 01/20] Create semantic-pr-linter Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> --- .github/workflows/semantic-pr-linter | 45 ++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/workflows/semantic-pr-linter diff --git a/.github/workflows/semantic-pr-linter b/.github/workflows/semantic-pr-linter new file mode 100644 index 000000000..d30cd5d1c --- /dev/null +++ b/.github/workflows/semantic-pr-linter @@ -0,0 +1,45 @@ +name: "Lint PR" + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +permissions: + pull-requests: write + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@v5 + id: lint_pr_title + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - uses: marocchino/sticky-pull-request-comment@v2 + # When the previous steps fails, the workflow would stop. By adding this + # condition you can continue the execution with the populated error message. + if: always() && (steps.lint_pr_title.outputs.error_message != null) + with: + header: pr-title-lint-error + message: | + Hey there and thank you for opening this pull request! 👋🏼 + + We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + + Details: + + ``` + ${{ steps.lint_pr_title.outputs.error_message }} + ``` + + # Delete a previous comment when the issue has been resolved + - if: ${{ steps.lint_pr_title.outputs.error_message == null }} + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: pr-title-lint-error + delete: true From 3aa4e4cf72a14d336e9d0e468a41b17e63110943 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 06:47:57 -0500 Subject: [PATCH 02/20] Rename semantic-pr-linter to semantic-pr-linter.yml Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> --- .github/workflows/{semantic-pr-linter => semantic-pr-linter.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{semantic-pr-linter => semantic-pr-linter.yml} (100%) diff --git a/.github/workflows/semantic-pr-linter b/.github/workflows/semantic-pr-linter.yml similarity index 100% rename from .github/workflows/semantic-pr-linter rename to .github/workflows/semantic-pr-linter.yml From ca276e244eb3cafb6035fc32d3548c7b247d9756 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 06:56:27 -0500 Subject: [PATCH 03/20] Update semantic-pr-linter.yml Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index d30cd5d1c..da00ee174 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -1,7 +1,7 @@ name: "Lint PR" on: - pull_request_target: + pull_request: types: - opened - edited From 2d03dfec1b346acd98a2d78fccff387f40b643f1 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 07:00:15 -0500 Subject: [PATCH 04/20] Update semantic-pr-linter.yml Signed-off-by: Dave Skender <8432125+DaveSkender@users.noreply.github.com> --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index da00ee174..d30cd5d1c 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -1,7 +1,7 @@ name: "Lint PR" on: - pull_request: + pull_request_target: types: - opened - edited From 3ba398290a0883da83606232b4ab0638177242d5 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 21:37:54 -0500 Subject: [PATCH 05/20] require subject capitalization --- .github/workflows/semantic-pr-linter.yml | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index d30cd5d1c..f36208238 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -19,6 +19,19 @@ jobs: id: lint_pr_title env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + + # Configure additional validation for the subject based on a regex. + # We enforce that the subject starts with an uppercase character. + subjectPattern: ^([A-Z]).+$ + + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: | + The subject "{subject}" found in the pull request title "{title}" + didn't match the configured pattern. Please ensure that the subject + starts with an uppercase character. - uses: marocchino/sticky-pull-request-comment@v2 # When the previous steps fails, the workflow would stop. By adding this @@ -28,11 +41,13 @@ jobs: header: pr-title-lint-error message: | Hey there and thank you for opening this pull request! 👋🏼 - - We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + + We require pull request titles to follow the + [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) + and it looks like your proposed title needs to be adjusted. Details: - + ``` ${{ steps.lint_pr_title.outputs.error_message }} ``` @@ -40,6 +55,6 @@ jobs: # Delete a previous comment when the issue has been resolved - if: ${{ steps.lint_pr_title.outputs.error_message == null }} uses: marocchino/sticky-pull-request-comment@v2 - with: + with: header: pr-title-lint-error delete: true From f06e1ab4024238856ed9cf9f039fa690de43796c Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 21:42:54 -0500 Subject: [PATCH 06/20] temp allow --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index f36208238..183e18064 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -1,7 +1,7 @@ name: "Lint PR" on: - pull_request_target: + pull_request: types: - opened - edited From 3cf27ab2a53ebc862a70f7c8cfbeeb7aa8384b26 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 21:53:05 -0500 Subject: [PATCH 07/20] update messaging --- .github/workflows/semantic-pr-linter.yml | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 183e18064..89e505a94 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -28,7 +28,7 @@ jobs: # If `subjectPattern` is configured, you can use this property to override # the default error message that is shown when the pattern doesn't match. # The variables `subject` and `title` can be used within the message. - subjectPatternError: | + subjectPatternError: > The subject "{subject}" found in the pull request title "{title}" didn't match the configured pattern. Please ensure that the subject starts with an uppercase character. @@ -39,18 +39,14 @@ jobs: if: always() && (steps.lint_pr_title.outputs.error_message != null) with: header: pr-title-lint-error - message: | + message: > Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. - Details: - - ``` - ${{ steps.lint_pr_title.outputs.error_message }} - ``` + >${{ steps.lint_pr_title.outputs.error_message }} # Delete a previous comment when the issue has been resolved - if: ${{ steps.lint_pr_title.outputs.error_message == null }} From 3b2bd4649d37213625b1e1050c6908bbdff0b761 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 21:56:06 -0500 Subject: [PATCH 08/20] more message updates --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 89e505a94..ce8c096e0 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -40,7 +40,7 @@ jobs: with: header: pr-title-lint-error message: > - Hey there and thank you for opening this pull request! 👋🏼 + ### Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) From 6d1cba6f78634b34b0c02211d8c6785da2b26842 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 21:57:13 -0500 Subject: [PATCH 09/20] more updates --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index ce8c096e0..e97ed2a09 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -29,7 +29,7 @@ jobs: # the default error message that is shown when the pattern doesn't match. # The variables `subject` and `title` can be used within the message. subjectPatternError: > - The subject "{subject}" found in the pull request title "{title}" + The subject "**{subject}**" found in the pull request title "*{title}*" didn't match the configured pattern. Please ensure that the subject starts with an uppercase character. From 137e4c42a6e232ea70e0a8a703a68ebd52b71641 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 22:01:39 -0500 Subject: [PATCH 10/20] trying more --- .github/workflows/semantic-pr-linter.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index e97ed2a09..dac989942 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -28,7 +28,7 @@ jobs: # If `subjectPattern` is configured, you can use this property to override # the default error message that is shown when the pattern doesn't match. # The variables `subject` and `title` can be used within the message. - subjectPatternError: > + subjectPatternError: | The subject "**{subject}**" found in the pull request title "*{title}*" didn't match the configured pattern. Please ensure that the subject starts with an uppercase character. @@ -39,7 +39,7 @@ jobs: if: always() && (steps.lint_pr_title.outputs.error_message != null) with: header: pr-title-lint-error - message: > + message: | ### Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the From 54e3300c3a9f68b786d7197e1116e5e9fe19e3ce Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 22:03:06 -0500 Subject: [PATCH 11/20] without custom message --- .github/workflows/semantic-pr-linter.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index dac989942..6c166af09 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -25,13 +25,7 @@ jobs: # We enforce that the subject starts with an uppercase character. subjectPattern: ^([A-Z]).+$ - # If `subjectPattern` is configured, you can use this property to override - # the default error message that is shown when the pattern doesn't match. - # The variables `subject` and `title` can be used within the message. - subjectPatternError: | - The subject "**{subject}**" found in the pull request title "*{title}*" - didn't match the configured pattern. Please ensure that the subject - starts with an uppercase character. + - uses: marocchino/sticky-pull-request-comment@v2 # When the previous steps fails, the workflow would stop. By adding this From db47bf20b46aea875c4c78a903a72b9bd3de7019 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 22:11:23 -0500 Subject: [PATCH 12/20] add back custom subject error message --- .github/workflows/semantic-pr-linter.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 6c166af09..e97ed2a09 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -25,7 +25,13 @@ jobs: # We enforce that the subject starts with an uppercase character. subjectPattern: ^([A-Z]).+$ - + # If `subjectPattern` is configured, you can use this property to override + # the default error message that is shown when the pattern doesn't match. + # The variables `subject` and `title` can be used within the message. + subjectPatternError: > + The subject "**{subject}**" found in the pull request title "*{title}*" + didn't match the configured pattern. Please ensure that the subject + starts with an uppercase character. - uses: marocchino/sticky-pull-request-comment@v2 # When the previous steps fails, the workflow would stop. By adding this @@ -33,7 +39,7 @@ jobs: if: always() && (steps.lint_pr_title.outputs.error_message != null) with: header: pr-title-lint-error - message: | + message: > ### Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the From 7b88878e98a112fda4dc6168cd6c9ab38551f16e Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 22:31:16 -0500 Subject: [PATCH 13/20] more customized messaging --- .github/workflows/semantic-pr-linter.yml | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index e97ed2a09..de585f104 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -33,6 +33,14 @@ jobs: didn't match the configured pattern. Please ensure that the subject starts with an uppercase character. + # If the PR contains one of these newline-delimited labels, the + # validation is skipped. If you want to rerun the validation when + # labels change, you might want to use the `labeled` and `unlabeled` + # event triggers in your workflow. + ignoreLabels: | + bot + ignore-semantic-pull-request + - uses: marocchino/sticky-pull-request-comment@v2 # When the previous steps fails, the workflow would stop. By adding this # condition you can continue the execution with the populated error message. @@ -42,9 +50,11 @@ jobs: message: > ### Hey there and thank you for opening this pull request! 👋🏼 - We require pull request titles to follow the - [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) - and it looks like your proposed title needs to be adjusted. + It looks like your proposed title needs to be adjusted. Our PR title follows the + [Conventional Commits specification](https://www.conventionalcommits.org) and uses + a naming convention of `[type]: [Subject]`, where **type** is typically `feat`, `fix`, + or `chore` and the **subject** starts with a capitalized letter (e.g. `feat: Big next thing` or + `fix: Divide by zero bug`, or `chore: Update docs`). >${{ steps.lint_pr_title.outputs.error_message }} From c590aaffda9f4e420dcb66b734f4d54379bc8b5d Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:00:56 -0500 Subject: [PATCH 14/20] now, just being silly with gold plating --- .github/workflows/semantic-pr-linter.yml | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index de585f104..391c04689 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -50,14 +50,22 @@ jobs: message: > ### Hey there and thank you for opening this pull request! 👋🏼 - It looks like your proposed title needs to be adjusted. Our PR title follows the - [Conventional Commits specification](https://www.conventionalcommits.org) and uses - a naming convention of `[type]: [Subject]`, where **type** is typically `feat`, `fix`, - or `chore` and the **subject** starts with a capitalized letter (e.g. `feat: Big next thing` or - `fix: Divide by zero bug`, or `chore: Update docs`). + It looks like your proposed title needs to be adjusted. >${{ steps.lint_pr_title.outputs.error_message }} + ### Pull request title naming convention + + Our PR title name taxonomy is `[type]: [Subject]`, where `[type]` is typically $feat$, $fix$, or $chore$ and `[subject]` is a *noun* that starts with a capitalized letter. The $chore$ type usually starts with an action *verb*. Examples: + + ``` + feat: Admin portal login + fix: Divide by zero bug in SMA + chore: Update user docs + ``` + + See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information. + # Delete a previous comment when the issue has been resolved - if: ${{ steps.lint_pr_title.outputs.error_message == null }} uses: marocchino/sticky-pull-request-comment@v2 From 425a3d64aa38c12232d765f982e0b3ab708aca9a Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:03:56 -0500 Subject: [PATCH 15/20] more --- .github/workflows/semantic-pr-linter.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 391c04689..4ad82765d 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -56,12 +56,16 @@ jobs: ### Pull request title naming convention - Our PR title name taxonomy is `[type]: [Subject]`, where `[type]` is typically $feat$, $fix$, or $chore$ and `[subject]` is a *noun* that starts with a capitalized letter. The $chore$ type usually starts with an action *verb*. Examples: + Our PR title name taxonomy is `[type]: [Subject]`, where `[type]` is typically + $feat$, $fix$, or $chore$ and `[subject]` is a *noun* that starts with a capitalized letter. + The $chore$ type usually starts with an action *verb*. Examples: ``` + feat: Admin portal login fix: Divide by zero bug in SMA chore: Update user docs + ``` See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information. From 2c99353ed5d71d89dd371ff8dc285ae60aa39fa8 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:04:47 -0500 Subject: [PATCH 16/20] more --- .github/workflows/semantic-pr-linter.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 4ad82765d..f172317fb 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -61,9 +61,11 @@ jobs: The $chore$ type usually starts with an action *verb*. Examples: ``` - + feat: Admin portal login + fix: Divide by zero bug in SMA + chore: Update user docs ``` From 76ed36524d9b4ff349483b5ccba91b02cde0dd72 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:08:29 -0500 Subject: [PATCH 17/20] more --- .github/workflows/semantic-pr-linter.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index f172317fb..abc2bfe7a 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -56,9 +56,10 @@ jobs: ### Pull request title naming convention - Our PR title name taxonomy is `[type]: [Subject]`, where `[type]` is typically - $feat$, $fix$, or $chore$ and `[subject]` is a *noun* that starts with a capitalized letter. - The $chore$ type usually starts with an action *verb*. Examples: + Our PR title name taxonomy is `type: Subject`, where **type** is typically + *feat*, *fix*, or *chore* and **subject** is a noun that starts with a capitalized letter. + The *chore* type usually has a subject that starts with an action verb like *Add* or *Update*. + Examples: ``` From 0aa1b22f6ff5b724840eb6a2ea295efc5991ce22 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:10:16 -0500 Subject: [PATCH 18/20] try emoji --- .github/workflows/semantic-pr-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index abc2bfe7a..6b2284e23 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -52,7 +52,7 @@ jobs: It looks like your proposed title needs to be adjusted. - >${{ steps.lint_pr_title.outputs.error_message }} + >:warning: ${{ steps.lint_pr_title.outputs.error_message }} ### Pull request title naming convention From 22792fb219c49140800cf7d8b1b639c71d9f38d8 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:12:17 -0500 Subject: [PATCH 19/20] different icon --- .github/workflows/semantic-pr-linter.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 6b2284e23..7f3fe1b79 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -48,13 +48,13 @@ jobs: with: header: pr-title-lint-error message: > - ### Hey there and thank you for opening this pull request! 👋🏼 + #### Hey there and thank you for opening this pull request! 👋🏼 It looks like your proposed title needs to be adjusted. - >:warning: ${{ steps.lint_pr_title.outputs.error_message }} + >🚩 ${{ steps.lint_pr_title.outputs.error_message }} - ### Pull request title naming convention + #### Pull request title naming convention Our PR title name taxonomy is `type: Subject`, where **type** is typically *feat*, *fix*, or *chore* and **subject** is a noun that starts with a capitalized letter. From 5cd0db13a21543f4be1a67d32b6218bdf65fdc57 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 31 Dec 2023 23:23:03 -0500 Subject: [PATCH 20/20] fin --- .github/workflows/semantic-pr-linter.yml | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml index 7f3fe1b79..c98c1bca8 100644 --- a/.github/workflows/semantic-pr-linter.yml +++ b/.github/workflows/semantic-pr-linter.yml @@ -1,7 +1,7 @@ name: "Lint PR" on: - pull_request: + pull_request_target: types: - opened - edited @@ -48,29 +48,18 @@ jobs: with: header: pr-title-lint-error message: > - #### Hey there and thank you for opening this pull request! 👋🏼 + ### Hey there and thank you for opening this pull request! 👋🏼 - It looks like your proposed title needs to be adjusted. + It looks like your proposed **_Pull request title_** needs to be adjusted. - >🚩 ${{ steps.lint_pr_title.outputs.error_message }} + >🚩 **ERROR:** ${{ steps.lint_pr_title.outputs.error_message }} #### Pull request title naming convention Our PR title name taxonomy is `type: Subject`, where **type** is typically *feat*, *fix*, or *chore* and **subject** is a noun that starts with a capitalized letter. The *chore* type usually has a subject that starts with an action verb like *Add* or *Update*. - Examples: - - ``` - - feat: Admin portal login - - fix: Divide by zero bug in SMA - - chore: Update user docs - - ``` - + Examples: `feat: Admin portal login`, `fix: Divide by zero bug in SMA`, and `chore: Update user docs`. See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information. # Delete a previous comment when the issue has been resolved