如何使用Python及GitLab API修改gitlab.yaml文件中的指定值

核心思路 #

通过GitLab官方Python库python-gitlab操作API，先获取目标文件的当前版本信息，修改内容后提交更新，同时用ruamel.yaml保留原文件的YAML格式（避免注释丢失、排版混乱）。

步骤实现 #

1. 安装依赖

需要两个关键库：

pip install python-gitlab ruamel.yaml

2. 完整代码示例

import gitlab
from ruamel.yaml import YAML

# 配置GitLab信息
GITLAB_URL = "https://gitlab.com"  # 替换为你的GitLab实例地址
PRIVATE_TOKEN = "your-personal-access-token"  # 替换为你的访问令牌
PROJECT_ID = "your-project-id"  # 替换为目标仓库的ID
FILE_PATH = ".gitlab-ci.yml"  # 注意文件路径，这里假设文件在仓库根目录

# 初始化GitLab客户端
gl = gitlab.Gitlab(GITLAB_URL, private_token=PRIVATE_TOKEN)
gl.auth()

# 获取目标项目
project = gl.projects.get(PROJECT_ID)

# 获取当前文件的信息（需要commit SHA用于更新冲突校验）
file = project.files.get(file_path=FILE_PATH, ref="main")  # 替换为文件所在的分支

# 解析YAML内容，保留原格式与注释
yaml = YAML()
yaml.preserve_quotes = True
content = yaml.load(file.decode())

# 修改目标字段：将only列表中的"main"替换为"develop"
if "gitlab_job" in content and "only" in content["gitlab_job"]:
    content["gitlab_job"]["only"] = [
        "develop" if item.strip() == "main" else item 
        for item in content["gitlab_job"]["only"]
    ]

# 将修改后的内容转回YAML字符串
updated_content = yaml.dump(content)

# 提交更新到仓库
project.files.update(
    file_path=FILE_PATH,
    branch="main",  # 替换为要提交的目标分支
    content=updated_content,
    commit_message="ci: update gitlab_job only branch to develop",
    last_commit_id=file.last_commit_id  # 基于最新版本修改，避免冲突
)

print("文件更新成功！")

关键注意事项 #

• 访问令牌权限：创建令牌时必须勾选api和write_repository权限，否则无法读写仓库文件。
• YAML格式保留：用ruamel.yaml而非原生pyyaml，可以完整保留原文件的注释、引号、缩进格式，避免不必要的格式变更。
• 冲突处理：如果在获取last_commit_id后文件被其他人修改，提交会失败。可以添加重试逻辑，或者在提交前重新获取文件的最新SHA值。
• 分支选择：代码中ref和branch参数要对应目标分支，确保修改提交到正确的分支上。

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