当前位置：首页 > article >正文

通过 GitLab API 实现 CHANGELOG.md 文件的自动化上传至指定分支

article 2024/9/30 19:38:53

在软件开发流程中，CHANGELOG.md 文件扮演着记录项目变更历史的重要角色。随着项目的迭代，定期更新 CHANGELOG 文件变得至关重要。然而，手动将更新后的 CHANGELOG.md 文件推送到 GitLab 仓库的指定分支可能会变得繁琐且容易出错，特别是在自动化部署和持续集成（CI）环境中。幸运的是，GitLab 提供了强大的 API，允许我们自动化这一过程。

步骤 1: 获取 GitLab API 访问令牌

首先，你需要在 GitLab 上创建一个个人访问令牌（Personal Access Token），以便你的脚本可以安全地访问 GitLab API。

登录到 GitLab。
进入“用户设置”（User Settings），选择“访问令牌”（Access Tokens）。
点击“新建个人访问令牌”（New Personal Access Token），输入令牌名称，并选择相应的作用域（至少需要“api”权限）。
复制生成的令牌，并在你的脚本或环境变量中安全地存储它。

步骤 2: 设置 GitLab API 环境变量

首先，你需要设置一些环境变量来存储 GitLab 服务器的基础 URL、访问令牌、项目 ID 和目标分支名。这些环境变量通常可以在你的 CI/CD 管道中设置，或者在你的本地机器上作为环境变量设置。

export CI_SERVER_URL="https://your-gitlab-server.com"
export TRIGGER_USER_ACCESSTOKEN="your_gitlab_api_token"
export CI_PROJECT_ID="your_project_id"
export BRANCH_NAME="your_target_branch"

确保替换上述环境变量中的占位符为实际的 GitLab 服务器地址、API 令牌、项目 ID 和目标分支名。

步骤 2: 编写 Python 脚本

接下来，我们将编写一个 Python 脚本来处理文件的读取、编码和上传过程。

import requests
import base64
import os

# 从环境变量中获取必要的配置
SERVER_URL = os.environ.get('CI_SERVER_URL')
GITLAB_API_BASE_URL = f"{SERVER_URL}/api/v4/"
GITLAB_API_TOKEN = os.environ.get('TRIGGER_USER_ACCESSTOKEN')
CI_PROJECT_ID = os.environ.get('CI_PROJECT_ID')
BRANCH = os.environ.get('BRANCH_NAME')

def upload_changelog(project_id, branch, token, file_path):
    url = f"{GITLAB_API_BASE_URL}/projects/{project_id}/repository/files/CHANGELOG.md"

    # 读取文件并转换为 base64 编码
    with open(file_path, "rb") as file:
        encoded_content = base64.b64encode(file.read()).decode('utf-8')

    # 构建请求头部和请求体
    headers = {
        'PRIVATE-TOKEN': token,
        'Content-Type': 'application/json'
    }
    data = {
        "branch": branch,
        "file_path": "CHANGELOG.md",
        "content": encoded_content,
        "encoding": "base64",
        "commit_message": 'ci: update CHANGELOG.md[skip ci]',
        "author_email": "your-email@example.com",  # 替换为你的 Git 邮箱
        "author_name": "Your Name"  # 替换为你的 Git 用户名
    }

    # 发送 POST 请求
    response = requests.post(url, headers=headers, json=data)
    print(response.json())

# 调用函数上传 CHANGELOG.md
upload_changelog(CI_PROJECT_ID, BRANCH, GITLAB_API_TOKEN, "CHANGELOG.md")

步骤 3: 运行脚本

将上述 Python 脚本保存为文件（例如 upload_changelog_to_gitlab.py），并在包含 CHANGELOG.md 文件的目录中运行它。确保你的环境变量已经设置正确，并且 Python 环境已经安装。

注意事项

权限问题：确保你的 GitLab API 令牌具有足够的权限来修改仓库内容。
文件编码：GitLab API 需要文件内容以 base64 编码的形式发送。
分支存在性：确保目标分支已经在 GitLab 仓库中存在。如果不存在，你可能需要先创建它，或者使用默认的分支（如 master 或 main）。
安全性：不要将敏感信息（如 API 令牌）硬编码在脚本中，而应使用环境变量或安全的配置管理系统。