deepakputhraya/action-branch-name

Github action to enforce naming convention on branch names

Branch naming rules

Github action to enforce naming convention on branch names

Usage

See action.yml

name: 'Assert Branch Naming Convention'
on: pull_request

jobs:
  branch-naming-rules:
    runs-on: ubuntu-latest
    steps:
      - uses: deepakputhraya/action-branch-name@master
        with:
          regex: '([a-z])+\/([a-z])+' # Regex the branch should match. This example enforces grouping
          allowed_prefixes: 'feature,stable,fix' # All branches should start with the given prefix
          ignore: master,develop # Ignore exactly matching branch names from convention
          min_length: 5 # Min length of the branch name
          max_length: 20 # Max length of the branch name

License

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

action-branch-name's Issues

Action fails when the event is a workflow_dispatch

Run deepakputhraya/action-branch-name@master
with:
regex: ([a-z])+/([a-zA-Z0-9_.-])+
allowed_prefixes: feature,stable,fix,hotfix
ignore: master,develop,dev,release,main
min_length: 5
max_length: 100
env:
REPOSITORY: ruby-apps-deploy
REPOSITORY_WORKFLOW: ruby-apps-workflows
AWS_DEFAULT_REGION: ***
Event name: workflow_dispatch
Error: Invalid event: workflow_dispatch

Support "create" event?

Would it be possible to support the create event trigger?

Reasoning: The developer should be notified immediately that the new branch is invalid before creating a pull request. I could use the push event, but it feels unnecessary to run the action for every push.

Action doesn't fail when it actually should

I have the following step:

        uses: deepakputhraya/action-branch-name@master
        with:
          regex: '([a-z])+\/([a-z\-\/])+' # Regex the branch should match. This example enforces grouping
          ignore: master,main,dev # Ignore exactly matching branch names from convention

My branch naming convention is that it should consist only of lowercase letters, slashes or minus signs. I.e. feature/my-new-feature would be a valid name, while with feature/myNewFeature it should throw an error.

If I put this regex into regex101.com, and add the test string, it doesn't match the whole string, which would be expected and which should make the action fail (!?)

But with exactly this example as a branch name, the action succeeds, also if it shouldn't.

bump nodejs to version 16

"Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: deepakputhraya/action-branch-name"

The following warning showed up in my CI annotation

Skip tags or other refs?

Can we specify refs/tags/.* in ignore?