# Branch naming rules <img alt="GitHub Actions status" src="https://github.com/payble-payments/action-branch-name/workflows/main/badge.svg"> Github action to enforce naming convention on branch names ## Usage See [action.yml](./action.yml) ```yaml name: 'Assert Branch Naming Convention' on: pull_request jobs: branch-naming-rules: runs-on: ubuntu-latest steps: - uses: payble-payments/action-branch-name@main 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 ``` This action was forked from [deepakputhraya/action-branch-name](https://github.com/deepakputhraya/action-branch-name) and updated using the template in [javascript-action](https://github.com/actions/javascript-action). ## License The scripts and documentation in this project are released under the [MIT License](./LICENSE)