如何批量导出、修改并导入GitLab CI环境变量？

针对批量导出、修改、导入GitLab项目CI变量的需求，以下是两种高效的实现方案，替代逐个处理的低效操作：

1. Python脚本方案（推荐，支持全变量属性） #

利用官方维护的python-gitlab库，可以一次性获取所有变量，批量处理后导入，支持保护、掩码、环境范围等所有变量属性。

步骤1：依赖安装 #

pip install python-gitlab pyyaml

步骤2：导出变量到YAML #

创建export_vars.py脚本：

import gitlab
import yaml

# 配置项，替换为你的实际信息
GITLAB_URL = "https://your-gitlab-instance.com"
PRIVATE_TOKEN = "your-personal-access-token"
PROJECT_ID = 123  # 项目ID，可从项目URL获取
EXPORT_FILE = "gitlab_ci_vars.yaml"

# 初始化GitLab客户端
gl = gitlab.Gitlab(GITLAB_URL, private_token=PRIVATE_TOKEN)
project = gl.projects.get(PROJECT_ID)

# 获取所有变量（自动处理分页）
variables = project.variables.list(all=True)

# 转换为可编辑的结构化数据
var_data = []
for var in variables:
    var_data.append({
        "key": var.key,
        "value": var.value,
        "protected": var.protected,
        "masked": var.masked,
        "variable_type": var.variable_type,
        "environment_scope": var.environment_scope
    })

# 写入YAML文件
with open(EXPORT_FILE, "w") as f:
    yaml.dump(var_data, f, sort_keys=False)

print(f"变量已成功导出到 {EXPORT_FILE}")

运行脚本：python export_vars.py，即可在本地得到包含所有变量的YAML文件，直接编辑修改即可。

步骤3：导入修改后的变量 #

创建import_vars.py脚本：

import gitlab
import yaml

# 配置项，替换为你的实际信息
GITLAB_URL = "https://your-gitlab-instance.com"
PRIVATE_TOKEN = "your-personal-access-token"
PROJECT_ID = 123
IMPORT_FILE = "gitlab_ci_vars.yaml"

# 初始化GitLab客户端
gl = gitlab.Gitlab(GITLAB_URL, private_token=PRIVATE_TOKEN)
project = gl.projects.get(PROJECT_ID)

# 读取本地变量文件
with open(IMPORT_FILE, "r") as f:
    var_data = yaml.safe_load(f)

# 批量更新/创建变量
for var in var_data:
    try:
        # 尝试更新现有变量
        existing_var = project.variables.get(var["key"])
        existing_var.value = var["value"]
        existing_var.protected = var["protected"]
        existing_var.masked = var["masked"]
        existing_var.variable_type = var["variable_type"]
        existing_var.environment_scope = var["environment_scope"]
        existing_var.save()
        print(f"✅ 已更新变量: {var['key']}")
    except gitlab.exceptions.GitlabGetError:
        # 变量不存在则创建
        project.variables.create(var)
        print(f"✅ 已创建变量: {var['key']}")

运行脚本：python import_vars.py，即可批量完成变量的更新和创建。

2. Bash + jq方案（轻量终端方案） #

如果你习惯终端操作，可结合curl和jq工具实现批量处理，无需Python环境。

前置准备 #

确保已安装jq（JSON处理工具），Debian/Ubuntu可通过sudo apt install jq安装。

导出变量到JSON #

创建export_vars.sh脚本：

#!/bin/bash

# 配置项
GITLAB_URL="https://your-gitlab-instance.com"
PRIVATE_TOKEN="your-personal-access-token"
PROJECT_ID=123
EXPORT_FILE="gitlab_ci_vars.json"

# 调用GitLab API获取所有变量（处理分页，单次最多100条）
curl -s --header "PRIVATE-TOKEN: ${PRIVATE_TOKEN}" \
  "${GITLAB_URL}/api/v4/projects/${PROJECT_ID}/variables?per_page=100" | jq '.' > ${EXPORT_FILE}

echo "变量已导出到 ${EXPORT_FILE}"

赋予执行权限并运行：chmod +x export_vars.sh && ./export_vars.sh

导入修改后的变量 #

创建import_vars.sh脚本：

#!/bin/bash

# 配置项
GITLAB_URL="https://your-gitlab-instance.com"
PRIVATE_TOKEN="your-personal-access-token"
PROJECT_ID=123
IMPORT_FILE="gitlab_ci_vars.json"

# 遍历JSON中的每个变量，批量处理
jq -c '.[]' ${IMPORT_FILE} | while read -r var; do
    KEY=$(echo "$var" | jq -r '.key')
    
    # 检查变量是否存在
    EXISTS=$(curl -s --header "PRIVATE-TOKEN: ${PRIVATE_TOKEN}" \
      "${GITLAB_URL}/api/v4/projects/${PROJECT_ID}/variables/${KEY}" | jq -r '.key')
    
    if [ "$EXISTS" == "$KEY" ]; then
        # 更新变量
        curl -s --request PUT --header "PRIVATE-TOKEN: ${PRIVATE_TOKEN}" \
          --header "Content-Type: application/json" \
          --data "$var" \
          "${GITLAB_URL}/api/v4/projects/${PROJECT_ID}/variables/${KEY}"
        echo "✅ 已更新变量: ${KEY}"
    else
        # 创建变量
        curl -s --request POST --header "PRIVATE-TOKEN: ${PRIVATE_TOKEN}" \
          --header "Content-Type: application/json" \
          --data "$var" \
          "${GITLAB_URL}/api/v4/projects/${PROJECT_ID}/variables"
        echo "✅ 已创建变量: ${KEY}"
    fi
done

赋予执行权限并运行：chmod +x import_vars.sh && ./import_vars.sh

关键注意事项 #

• 个人访问令牌需具备api权限，至少包含read_variables和write_variables权限
• 导出的变量文件包含敏感信息，请勿提交到版本控制系统，需妥善保管
• 针对变量数量超过100的大型项目，Bash脚本需手动处理分页（Python脚本已自动处理）
• 导入前建议先测试单个变量的修改和导入，避免批量操作出错

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