🌐 命名统一规范推荐(Git 分支 → Docker 镜像 → K8s 命名空间 → 文件目录)

52 阅读1分钟

🌐 命名统一规范整理(Git 分支 → Docker 镜像 → K8s 命名空间 → 文件目录)

flowchart TD
    A[Git 分支:feature/item_equip] --> B[Docker 镜像 tag<br> feature-item-equip--hashxxxx]
    A --> C[Kubernetes 命名空间<br> feature-item-equip]
    A --> D[文件目录<br> env--feature-item-equip]

🔧 统一转换规则

来源(Git 分支名)示例
原始 Git 分支名feature/item-equip
Docker 镜像 tagfeature-item-equip--hashxxxx
Kubernetes 命名空间feature-item-equip
本地目录名dev--feature-item-equip/

📜 命名标准说明

1. Git 分支命名

  • 格式:<类型>/<模块名>
  • 类型包括:
    • feature: 新功能
    • bugfix: 修复
    • release: 发布
    • hotfix: 紧急修复
  • 模块名使用小写、中划线连接,例如:feature/item-equip

2. Docker 镜像 tag 命名

  • 全部使用中划线连接语义片段
  • 使用 -- 分隔逻辑块(如主体与版本/哈希),例如:feature-item-equip--bd6a2f1
  • 遵循格式 [[:alnum:]][[:alnum:].-_]*

3. Kubernetes 命名空间

  • 将分支名中 / 替换为 -
  • 小写,仅含字母数字和 -
  • 满足 RFC 1123 子域名规范,例如:feature-item-equip

4. 文件目录命名

  • 与分支名称保持一致,全部使用中划线
  • 可选使用 -- 加上分支版本或环境,例如:dev--feature-item-equip/

✅ 示例转换表

Git 分支名Docker 镜像 tagK8s 命名空间本地目录名
feature/item-equipfeature-item-equip--bd6a2f1feature-item-equipdev--feature-item-equip/
bugfix/login-issuebugfix-login-issue--a7e3df4bugfix-login-issuedev--bugfix-login-issue/
release/v1.2.3release-v1-2-3--faa9e21release-v1-2-3release-v1-2-3--release/

🧠 建议

  • 所有命名统一使用中划线,简洁、兼容性好;
  • 在需要明确语义边界(如 tag 和目录)时使用 -- 分隔;
  • 合并主干后可将目录命名精简为 模块名/
  • 自动化脚本中可通过 -- 切割逻辑字段。