Skip to main content

此版本的 GitHub Enterprise 将停止服务 2023-01-18. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

处理分支和标记名称中的特殊字符

对于在分支和标签名称中允许的字符,Git 的支持非常宽泛。 从命令行 shell 使用 Git 时,可能需要对特殊字符进行转义或引用。

关于分支和标记名称

大多数存储库都使用简单的分支名称,例如 mainupdate-icons。 标记名称通常也遵循基本格式,例如版本号 v1.2.3。 分支名称和标签名称也可使用路径分隔符 (/) 来表示结构,例如 area/itemlevel-1/level-2/level-3。 除了一些例外 — 例如名称不以斜线开头或结尾,或者名称中有连续的斜线 — Git 对分支和标签名称中可使用的字符几乎没有限制。 有关详细信息,请参阅 Git 文档中的“git-check-ref-format”。

为什么需要对特殊字符进行转义

使用 CLI 时,您可能会遇到分支或标记名称包含对 shell 环境具有特殊含义的特殊字符的情况。 要在 Git 命令中安全地使用这些字符,必须用引号或转义它们,否则该命令可能会产生意外效果。

例如,$ 字符被许多 shell 用来引用变量。 大多数 shell 会将 hello-$USER 这样的有效分支名称解释为等同于单词“hello”,后跟一个连字符,再后跟 USER 变量的当前值(而不是文字字符串 hello-$USER)。 如果分支名称包含 $ 字符,则必须阻止 shell 将其扩展为变量引用。 同样,如果分支名称包含分号 (;),大多数 shell 会将其解释为命令分隔符,因此需要对其进行引用或转义。

如何对分支和标记名称中的特殊字符进行转义

大多数带有特殊字符的分支和标签名称都可通过将名称包含在单引号中来处理,例如 'hello-$USER'

  • Bash shell 中,将字符串括在单引号中可保留单引号中字符的文本值。
  • Zsh 的行为类似于 Bash,但是可使用 RC_QUOTES 选项配置此行为。
  • PowerShell 还会按字面意思处理单引号内的字符。

对于这些 shell,主要的例外是分支或标记名称本身包含单个引号。 在这种情况下,您应该查阅 shell 的官方文档:

命名分支和标记

如果可能,请创建不包含特殊字符的分支和标记名称,因为这些字符需要转义。 用于分支名称和标记名称的安全默认字符集为:

  • 英文字母(a-zA-Z
  • 数字 (0-9)
  • 有限的标点字符集:
    • 句点 (.)
    • 连字符 (-)
    • 下划线 (_)
    • 正斜杠 (/)

为避免混淆,分支名称应以字母开头。