From 095fd98fc511143eff66c9be697e8f298c2d341e Mon Sep 17 00:00:00 2001 From: Kai Koenig Date: Thu, 18 Jul 2024 09:27:09 +1200 Subject: [PATCH 1/2] Added yaml file for checking conventional commit style at PR time --- .github/workflows/pr.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .github/workflows/pr.yml diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 00000000..e69de29b From 5e0b4d0ef3d9973b3bc30fd77b8fcede0038bc67 Mon Sep 17 00:00:00 2001 From: Kai Koenig Date: Thu, 18 Jul 2024 09:27:20 +1200 Subject: [PATCH 2/2] Added yaml file for checking conventional commit style at PR time --- .github/workflows/pr.yml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index e69de29b..2e9b0858 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -0,0 +1,37 @@ +name: "Pull-Request Check" + +on: + pull_request: + types: + - opened + - edited + - synchronize + +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: | + 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 \ No newline at end of file