deepakputhraya / action-pr-title

Github action to enforce Pull Request title conventions

Branch naming rules

Github action to enforce Pull Request title conventions

Usage

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
    github_token: ${{ github.token }} # Default: ${{ github.token }}

Note:

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]

Triggering the action on anything other than pull_request will cause a failure.

License

The scripts and documentation in this project are released under the MIT License

action-pr-title's Issues

Prefix Error Not Right

It's saying my prefix isn't correct but it is, not sure how to debug or fix it from here

disallowed_prefixes doesn't work as epected

I don't see why this PR title is matching with the disallowed prefixes.
Would you please help?
Thank.

Regex validation isnt working properly

I have the following workflow

validate-pr-title:
        name: PR Title Validation
        runs-on: ubuntu-latest
        steps:
          - uses: deepakputhraya/action-pr-title@master
            with:
              regex: '((feature|bugfix|hotfix)\/){0,1}(MULE|HUG)-\d+'
              prefix_case_sensitive: true
              github_token: ${{ github.token }}

This is the output of the job:

This is what it should have done

Why isn't it failing if the PR title does not match the regex?

action-pr-title/index.js

Lines 43 to 47 in 3864beb

	const regex = RegExp(core.getInput('regex'));
	if (!regex.test(title)) {
	core.setFailed(`Pull Request title "${title}" failed to pass match regex - ${regex}`);
	return
	}

[Feature Request] Add disallowed prefixes

Hi

Thanks for this

In my case I would like to not allow to have PRs that starts with feature/ but just feature is ok.

I dont see a way to setup this with this one.

re-run the action after renaming the PR title does not work

• Create a PR with bad title
• Github Action fails
• Rename PR with good title
• Re-run Github action
• Github action fails again on the previous PR title

Only solution I found is to close/open a new PR or kick the build via commit; both are not great.

Not working

`

Update to Node 16

We're using this action in our project and I noticed that Github Actions issues warnings stating that Node 12 does not receive support anymore as of April 2022, see Github Blog.

I think it's as easy as replacing

runs:
  using: 'node12'
  main: 'index.js'

with

runs:
  using: 'node16'
  main: 'index.js'

in action.yml.

Runs only on default branch

This might be more of a github-actions question than an issue with this action. I'm new to github-actions so would appreciate some help :)

This is the yml script that I use but it triggers only on PRs based on the master (default) branch. When I open a PR on a release/... branch, this is not triggered. I assumed that if I don't specifically set a branch under the on: condition, it should work for all branches. Is that not the case?

name: PR Title Check

on:
  pull_request:
    types: [ opened, edited, synchronize, reopened ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Pull Request title rules
        uses: deepakputhraya/[email protected]
        with:
          regex: {redacted}