Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 954 Bytes

git_branch_name.md

File metadata and controls

46 lines (31 loc) · 954 Bytes
Raw

Git branch name

The Git branch name task ensures that the current branch name matches the specified patterns.
For example: if you are working with JIRA, it is possible to add a pattern for the JIRA issue number.

# grumphp.yml
parameters:
    tasks:
        git_branch_name:
            matchers:
                Branch name must contain JIRA issue number: /JIRA-\d+/
            additional_modifiers: ''

matchers

Default: []

Use this parameter to specify one or multiple patterns. The value can be in regex or glob style. Here are some example matchers:

  • /JIRA-([0-9]*)/
  • pre-fix*
  • *suffix
  • ...

additional_modifiers

Default: ''

Add one or multiple additional modifiers like:

additional_modifiers: 'u'

# or

additional_modifiers: 'xu'

allow_detached_head

Default: true

Set this to false if you wish the task to fail when ran on a detached HEAD. If set to true the task will always pass.