分类

← View All Tools

Git分支名称验证器

根据Git命名约定验证Git分支名称

Git分支名称验证器

此工具根据Git的命名约定和最佳实践验证Git分支名称。

Git分支命名规则：

不能包含：~ ^ : 空格制表符换行符 ? * [ \
不能以/开头或结尾
不能有连续的斜杠//
不能以.lock结尾
不能包含..或@{
最大长度（通常为255个字符以保持文件系统兼容性）
不能是保留的分支名称（HEAD、main、master）

常见分支命名约定：

feature/ - 新功能
bugfix/ - 错误修复
hotfix/ - 紧急生产修复
release/ - 发布准备
develop/ - 开发分支
test/ - 测试分支
docs/ - 文档更新
refactor/ - 代码重构

有效名称示例：

feature/user-authentication
bugfix/login-error
hotfix/security-patch-001
release/v1.2.3

无效名称示例：

feature user auth（包含空格）
feature//double-slash（连续斜杠）
.lock-branch（以点开头）
feature/.lock（以.lock结尾）

使用场景：

创建前验证分支名称
强制团队命名约定
分支命名的预提交钩子
CI/CD管道验证
代码审查自动化

关键信息

分类: Development
输入类型: text, checkbox, number
输出类型: json
样本覆盖: 4
支持 API: Yes

概览

Git分支名称验证器是一款专为开发人员设计的实用工具，旨在根据Git命名规范和最佳实践，快速检查分支名称是否合规，确保团队协作中的代码库整洁且兼容性良好。

适用场景

•在创建新分支前，快速验证名称是否符合团队命名规范。
•在配置CI/CD流水线或预提交钩子（Pre-commit hooks）时，测试分支命名规则。
•在代码审查过程中，检查分支命名是否包含非法字符或保留字。

工作原理

•输入您拟定的Git分支名称。
•根据需要勾选“强制执行命名约定”或设置自定义前缀。
•点击验证按钮，工具将根据Git命名规则（如禁止空格、连续斜杠、保留字等）进行实时分析。
•查看验证结果，系统将明确指出名称中存在的违规项或确认其为有效名称。

使用场景

团队协作：统一全员分支命名格式，减少合并冲突与沟通成本。

自动化流程：将验证逻辑集成到CI/CD脚本中，拒绝不规范的分支推送。

代码维护：通过规范化命名，使分支用途一目了然，提升代码库的可读性。

用户案例

1. 验证新功能分支命名

前端开发工程师

背景原因: 团队要求所有功能分支必须以 'feature/' 开头，且不能包含特殊字符。
解决问题: 不确定拟定的分支名 'feature/user_login_v2' 是否符合规范。
如何使用: 在分支名称输入框输入 'feature/user_login_v2'，并确保 '强制执行命名约定' 已勾选。
示例配置: allowedPrefixes: 'feature/,bugfix/'
效果: 工具提示验证通过，确认该名称符合团队规范。

2. 排查无效分支名

DevOps工程师

背景原因: 在编写自动化脚本时，发现某个分支名导致脚本报错。
解决问题: 需要快速确认该分支名 'hotfix//urgent-patch' 为什么无效。
如何使用: 输入 'hotfix//urgent-patch' 进行验证。
效果: 工具指出 'hotfix//urgent-patch' 包含连续斜杠 '//'，属于非法命名，建议修改为 'hotfix/urgent-patch'。

用 Samples 测试

development

Git分支名称示例

用于验证测试的Git分支名称集合，包括有效模式、无效格式和真实示例

title token git,branch,name

sample

无效变量名代码示例

展示不同编程语言中无效变量命名约定的示例代码文件

keywords name,naming,convention

sample

GitHub Actions Testing - CI/CD测试集成

全面的 GitHub Actions 测试工作流，包括自动化测试、并行执行、测试报告、缓存和现代开发流水线的高级 CI/CD 模式

常见问题

为什么分支名称不能包含空格？

空格会导致Git命令行解析错误，并在某些操作系统或脚本中引发路径引用问题。

什么是保留的分支名称？

如HEAD、main、master等名称在Git内部具有特殊含义，使用它们作为普通分支名会导致引用冲突。

为什么分支名不能以.lock结尾？

.lock后缀通常用于Git内部的索引锁定文件，使用该后缀会干扰Git的正常操作。

该工具支持自定义前缀吗？

支持。您可以在配置选项中设置允许的前缀，例如feature/、bugfix/等，以匹配团队的特定约定。

分支名称的最大长度是多少？

为了保持跨文件系统的兼容性，建议遵循Git的惯例，将长度限制在255个字符以内。

API 文档

请求端点

POST /zh/api/tools/git-branch-validator

请求参数

参数名	类型	必填	描述
branchName	text	是	-
allowCustomPrefixes	checkbox	否	Allow branch names without standard prefixes
enforceConvention	checkbox	否	Require branch names to follow naming conventions
reservedNames	text	否	Branch names that are reserved (comma-separated)
maxLength	number	否	Maximum length for branch names (filesystem compatibility)
allowedPrefixes	text	否	Valid branch name prefixes (comma-separated, end with /)

响应格式

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

JSON数据: JSON数据

AI MCP 文档

将此工具添加到您的 MCP 服务器配置中：

{
  "mcpServers": {
    "elysiatools-git-branch-validator": {
      "name": "git-branch-validator",
      "description": "根据Git命名约定验证Git分支名称",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=git-branch-validator",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

你可以串联多个工具，比如：`https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`，最多20个。

如果遇见问题，请联系我们：[email protected]

分类

Git分支名称验证器