Skip to content

Commit

Permalink
Merge pull request #3 from getindata/feat/add-gh-validate-pr-title-wo…
Browse files Browse the repository at this point in the history
…rkflow

feat: Add GitHub validate pr title workflow
  • Loading branch information
kacpermuda authored Sep 8, 2023
2 parents 0b862a4 + 70e1492 commit 9d98c9a
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/_self-validate-pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Validate PR title

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
release:
uses: getindata/github-workflows/.github/workflows/gh-validate-pr-title.yml@main
46 changes: 46 additions & 0 deletions .github/workflows/gh-validate-pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Validate PR title

on:
- workflow_call

jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
# Please look up the latest version from
# https://github.com/amannn/action-semantic-pull-request/releases
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
# Configure which types are allowed.
# Default: https://github.com/commitizen/conventional-commit-types
types: |
feat
fix
improvement
docs
refactor
test
ci
chore
# Configure that a scope must always be provided.
requireScope: false
# Configure additional validation for the subject based on a regex.
# This example ensures 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.
# For work-in-progress PRs you can typically use draft pull requests
# from Github. However, private repositories on the free plan don't have
# this option and therefore this action allows you to opt-in to using the
# special "[WIP]" prefix to indicate this state. This will avoid the
# validation of the PR title and the pull request checks remain pending.
# Note that a second check will be reported if this is enabled.
wip: true

0 comments on commit 9d98c9a

Please sign in to comment.