https://github.com/deepakputhraya/action-branch-name

Github action to enforce naming convention on branch names
https://github.com/deepakputhraya/action-branch-name

branching-strategies github-actions hacktoberfest pull-requests pullrequest pullrequests

Last synced: 3 months ago
JSON representation

Github action to enforce naming convention on branch names

• Host: GitHub
• URL: https://github.com/deepakputhraya/action-branch-name
• Owner: deepakputhraya
• License: mit
• Created: 2019-10-11T10:59:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-12T17:48:45.000Z (12 months ago)
• Last Synced: 2024-10-26T09:30:20.796Z (3 months ago)
• Topics: branching-strategies, github-actions, hacktoberfest, pull-requests, pullrequest, pullrequests
• Language: JavaScript
• Homepage:
• Size: 378 KB
• Stars: 77
• Watchers: 3
• Forks: 42
• Open Issues: 7
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-actions - Action to enforce branch naming rules
• fucking-awesome-actions - Action to enforce branch naming rules
• awesome-workflows - Action to enforce branch naming rules

README

        
# Branch naming rules



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: 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](./LICENSE)