b12k / branch-name-lint Goto Github PK

We found this package that works for validating branch names at the developer workstation via a git hook.

However we also want to enforce the branch name inside a Github Workflow running with the pull_request event.
In that context, the library is not able to successfully get the name of the branch (I think to have found that uses this git command: git rev-parse --abbrev-ref HEAD), getting something like HEAD instead of the name of the branch being merged.

That name comes in the workflow variable github.head_ref but I have not found a way to inject that name into the library.

Can you think of a way that the name of the branch name can be successfully detected in different scenarios/injected via the command line?

Thanks in advance

If i want to allow push to develop branch, how can i configure the regular expression?.

i'm using

module.exports = {
  pattern: ':type/:user/:month/:name',
  params: {
    type: ['feature', 'fix', 'docs', 'misc', 'improve', 'introduce'],
    user: ['[a-z0-9-]+\\.[a-z0-9-]+'],
    month: ['\\d{4}-\\d{2}'],
    name: ['[a-z0-9-]+']
  },
  prohibited: ['ci', 'wip', 'main', 'test', 'build', 'master', 'release']
};

Thanks