From ad594c7cb2105e0eff72d1767b2ddcc4dc0e3d38 Mon Sep 17 00:00:00 2001 From: Thomas Schuetz <38893055+thschue@users.noreply.github.com> Date: Fri, 24 Mar 2023 22:46:00 +0100 Subject: [PATCH] chore: add semantic pr validation (#66) Signed-off-by: Thomas Schuetz --- .github/workflows/semantic_pr.yaml | 53 ++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/workflows/semantic_pr.yaml diff --git a/.github/workflows/semantic_pr.yaml b/.github/workflows/semantic_pr.yaml new file mode 100644 index 0000000000..1c9634989e --- /dev/null +++ b/.github/workflows/semantic_pr.yaml @@ -0,0 +1,53 @@ +name: Semantic PR Validation +on: + pull_request_target: + types: + - opened + - edited + - synchronize +defaults: + run: + shell: bash +jobs: + validate: + runs-on: ubuntu-22.04 + steps: + - name: Validate Pull Request + uses: amannn/action-semantic-pull-request@v5.2.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Configure which types are allowed. + # Default: https://github.com/commitizen/conventional-commit-types + types: | + feat + fix + build + chore + ci + docs + perf + refactor + revert + style + test + deps + scopes: | + deps + # Configure that a scope must always be provided. + requireScope: false + # When using "Squash and merge" on a PR with only one commit, GitHub + # will suggest using that commit message instead of the PR title for the + # merge commit, and it's easy to commit this by mistake. Enable this option + # to also validate the commit message for one commit PRs. + validateSingleCommit: true + # Configure additional validation for the subject based on a regex. + # This ensures the subject doesn't start 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 + doesn't start with an uppercase character. \ No newline at end of file