GitHub Action
Pull Request title rules
v1.0.2
Latest version
Github action to enforce Pull Request title conventions
See action.yml
steps:
- uses: deepakputhraya/action-pr-title@master
with:
regex: '([a-z])+\/([a-z])+' # Regex the title should match.
allowed_prefixes: 'feature,fix,JIRA' # title should start with the given prefix
disallowed_prefixes: 'feat/,hotfix' # title should not start with the given prefix
prefix_case_sensitive: false # title prefix are case insensitive
min_length: 5 # Min length of the title
max_length: 20 # Max length of the title
verbal_description: 'Two words with a slash (/) between' # Verbal description of the regex rule
github_token: ${{ github.token }} # Default: ${{ github.token }}Ensure to add types to the Pull requests webhook event as by default workflows are triggered only
for opened, synchronize, or reopened pull request events. Read more about
it here.
on:
pull_request:
types: [opened, edited, synchronize, reopened]or here.
on:
pull_request_target:
types: [opened, edited, synchronize, reopened]Triggering the action on anything other than pull_request or pull_request_target will cause a failure.
In case the action fails with the following error:
Event name: pull_request
Error: Resource not accessible by integration
You can fix this, by adding the following to your workflow:
permissions:
pull-requests: readThe scripts and documentation in this project are released under the MIT License