robo.yml

# Automatically Generated from 'robo validate:init-robo-yml'.
# See ./vendor/mattsqd/robovalidate/robo.example.yml for additional context.
command:
    validate:
        options:
            project-id: BSD
        commit-messages:
            options:
                # The regular expression that must match for all commits not in 'target-branch'.
                pattern: '/^{$project_id} (close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved) #\d+: /'
                short-help: "Commit messages must follow these guidelines:"
                long-help:
                    - '<!> Note the space before the description.'
                    - '{$project_id} [KEYWORD] #[ISSUE_NUMBER]: [DESCRIPTION]'
                    - ''
                    - 'Available keywords: close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved.'
                    - ''
                    - 'Example: ''{$project_id} fixes #64: Fixed coding standards issues.'''
                    - ''
                    - 'How do I update my commit messages?'
                    - 'See https://www.atlassian.com/git/tutorials/rewriting-history'
                    - ''
                    - 'After re-rewriting the history, you should --force-with-lease the push.'
                    - 'https://stackoverflow.com/questions/52823692/git-push-force-with-lease-vs-force#:~:text=%2D%2Dforce%2Dwith%2Dlease%20is%20a%20safer%20option%20that%20will,elses%20work%20by%20force%20pushing.'
        branch-name:
            options:
                pattern: '/^feature\/{$project_id}-([\d]{1,})-(?!.*--)([a-z\d]{1})([a-z\d-]{3,})([a-z\d]{1})$/'
                custom-help:
                    - 'Feature branches'
                    - ''
                    - 'feature/{$project_id}-[ISSUE_NO]-[LOWER_CASE_DESCRIPTION]'
                    - ''
                    - 'Example: feature/{$project_id}-64-robo-validate.'
                    - ''
                    - ' The description has specific requirements of:'
                    - ' - Always lower case.'
                    - ' - Starts and end with a letter or integer.'
                    - ' - Contains letters, integers, or dashes (non-consecutive).'
                    - ' - At least 5 characters long.'
                # These refer to all the possible branch names. There are 4 different types and they will be
                # described below. If you'd like to override any of these, you must put all back in that you'd like to
                # use, they will not be merged together.
                valid-branch-names:
                    # Matches a branch named 'develop'.
                    - 'explicit|develop'
                    # Matches a branch named 'main'.
                    - 'explicit|main'
                    # Matches a custom regular expression found in $pattern.
                    - 'custom|'
                    # Matches a branch like: hotfix/2.1.3.
                    - 'semantic|hotfix'
                    # Matches a branch like (the last number MUST be a 0): release/2.1.0.
                    - 'semantic_end_0|release'
                    # Matches a branch named 'stage' (MOD FROM DEFAULTS).
                    - 'explicit|stage'