Elysia Tools
Navigation
Development
Validate Git branch names according to Git naming conventions
Details
This tool validates Git branch names according to Git's naming conventions and best practices.
Git Branch Naming Rules:
~ ^ : space tab newline ? * [ \///.lock.. or @{Common Branch Naming Conventions:
Example Valid Names:
feature/user-authenticationbugfix/login-errorhotfix/security-patch-001release/v1.2.3Example Invalid Names:
feature user auth (contains spaces)feature//double-slash (consecutive slashes).lock-branch (starts with dot)feature/.lock (ends with .lock)Use Cases:
Execution
Fill in the form, run the tool, and review the result in one place.
Samples
Related
Tool usage guide
The Git Branch Name Validator checks branch names against Git's official naming conventions and customizable rules, helping developers avoid errors and maintain consistent repository practices.
Background
A developer is creating a branch for a new login feature.
Problem
Ensure the branch name 'feature/user-login' follows Git conventions and team standards.
How to use
Enter 'feature/user-login' in the branch name field and submit for validation.
Outcome
The tool confirms the name is valid, allowing the branch to be created without issues.
Background
A team wants to automate branch name checks in their CI/CD pipeline.
Problem
Prevent branches with invalid names or missing prefixes from being merged.
How to use
Configure the tool with enforceConvention set to true and allowedPrefixes as 'feature/,bugfix/,hotfix/', then validate branch names in the pipeline.
enforceConvention: true, allowedPrefixes: 'feature/,bugfix/,hotfix/'Outcome
Invalid branch names are flagged, ensuring only compliant names proceed, maintaining repository consistency.
It checks for characters like ~, ^, :, spaces, tabs, newlines, ?, *, [, \, and others as per Git rules.
Yes, use the allowedPrefixes option to specify prefixes such as 'feature/', 'bugfix/', or others.
The default is 255 characters for filesystem compatibility, but you can adjust it with the maxLength option.
Use the reservedNames option to input comma-separated names like 'HEAD,main,master' that should be avoided.
The result is in JSON format, showing whether the name is valid and any errors found.