如何在GitLab CI/CD中模板化Bash例程并安全转换分支名

方案一：提取为可复用的Bash函数 #

这是最轻量化的方案，完全适配GitLab CI的Bash运行环境，无需额外依赖，适合简单的字符串处理逻辑。

实现方式 #

1. 在CI配置中定义全局复用函数，可放在before_script中让所有Job共享，或者封装成单独的脚本文件引用：

# 全局前置脚本，定义通用清理函数
before_script:
  - |
    # 清理分支名：将/和_替换为-，可按需扩展其他非法字符
    get_safe_branch_name() {
      local raw_branch="$1"
      echo "$raw_branch" | tr '/_' '-'
    }

# 具体部署Job中调用函数
deploy_to_juju:
  script:
    - SAFE_BRANCH_NAME=$(get_safe_branch_name "$UPSTREAM_BRANCH")
    - echo "清理后的分支名：$SAFE_BRANCH_NAME"
    - juju add-model "$SAFE_BRANCH_NAME"

2. 跨项目复用的话，可将函数写入单独的.gitlab-ci-utils.sh文件，在CI配置中引入：

before_script:
  # 从项目内部文件加载工具函数
  - source .gitlab-ci-utils.sh

方案二：Python脚本/模块（适合复杂逻辑） #

如果变量清理规则复杂（比如需要正则匹配、长度校验、多字符组合过滤），用Python实现会更易维护，代码可读性更强。

轻量版：直接用Python脚本 #

无需打包成模块，直接在CI中调用脚本即可：

# safe_branch_cleaner.py
def clean_branch_name(raw_name):
    # 替换/和_为-，可添加更多规则
    cleaned = raw_name.replace('/', '-').replace('_', '-')
    # 可选：添加长度限制、特殊字符过滤等
    return cleaned[:32]  # 比如Juju模型名有长度限制

if __name__ == "__main__":
    import sys
    if len(sys.argv) != 2:
        sys.exit(1)
    print(clean_branch_name(sys.argv[1]))

在CI配置中调用：

deploy_to_juju:
  script:
    # 确保runner预装Python，否则先安装
    - apt-get update && apt-get install -y python3
    - SAFE_BRANCH_NAME=$(python3 safe_branch_cleaner.py "$UPSTREAM_BRANCH")
    - juju add-model "$SAFE_BRANCH_NAME"

进阶版：打包成PyPI模块 #

如果需要跨多个项目复用，可将逻辑打包成PyPI模块（支持私有PyPI源）：

1. 编写模块并发布到PyPI
2. 在CI中安装并调用：

deploy_to_juju:
  script:
    - pip install your-branch-cleaner-package
    - SAFE_BRANCH_NAME=$(python3 -c "from branch_cleaner import clean_branch_name; print(clean_branch_name('$UPSTREAM_BRANCH'))")
    - juju add-model "$SAFE_BRANCH_NAME"

方案对比 #

• Bash函数：适合简单规则，无额外依赖，执行效率高，是GitLab CI场景下的首选。
• Python方案：适合复杂逻辑，代码易扩展和维护，跨语言场景也能复用，但需要依赖Python环境。

内容的提问来源于stack exchange，提问作者Erik