Skip to content

Checks if newly created branches follow a convention defined within a regular expression

License

Notifications You must be signed in to change notification settings

duart38/branch-convention-check

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Branch convention checking

Usage

name: Check branch convention usage
on: 
  pull_request:
    types: [opened]

jobs:
  branching:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v2
      - name: Check the branch convention usage
        uses: duart38/branch-convention-check@v2.1.0
        with:
          standard_branch_check: '(\b(?:fix|feat|ci|patch)\b(-([0-9])+|)\b(?:-[a-z]{3,})+\b)'
          ignore_branch_check: '(\b(?:testing)\b(-([0-9])+|)\b(?:-[a-z]{3,})+\b)'
          ignore: 'main' # No-space comma separated branches to ignore. above regex will be checked BEFORE this runs