能否通过gitlab python API获取等价于git describe --tags的结果?
问题解答
可以通过python-gitlab库调用GitLab接口拿到等价于git describe --tags的执行结果,完全适配GitLab Runner浅克隆的场景,不需要拉取完整仓库就能获取版本信息用于conan构建。
具体实现步骤
- 先安装依赖包:
pip install python-gitlab - 配置GitLab认证信息:建议在CI变量中配置
GITLAB_PRIVATE_TOKEN(权限只需要仓库读取权限即可),实例化GitLab客户端时直接读取环境变量即可,避免硬编码凭证。 - 调用项目标签列表接口,按更新时间倒序排序取第一条,即可得到仓库的最新标签。如果需要完全对齐原生
git describe --tags的输出格式,可以额外获取当前CI作业对应提交的哈希,和最新标签指向的提交哈希做比对:- 两者一致时直接输出标签名
- 两者不一致时,统计最新标签之后到当前提交的提交数,拼接为
{标签名}-{提交偏移数}-g{当前提交短哈希}格式即可,和原生命令输出完全一致
示例参考代码
import gitlab import os # 从CI环境变量读取必要参数 gl = gitlab.Gitlab(os.getenv("CI_SERVER_URL"), private_token=os.getenv("GITLAB_PRIVATE_TOKEN")) project = gl.projects.get(os.getenv("CI_PROJECT_ID")) current_sha = os.getenv("CI_COMMIT_SHA") # 获取最新标签 tags = project.tags.list(order_by="updated", sort="desc", per_page=1) latest_tag = tags[0] # 比对提交哈希 if latest_tag.commit["id"] == current_sha: describe_result = latest_tag.name else: # 统计标签到当前提交的偏移数 commit_diff = project.commits.list(ref_name=current_sha, since=latest_tag.commit["created_at"], per_page=100) offset = len(commit_diff) short_sha = current_sha[:8] describe_result = f"{latest_tag.name}-{offset}-g{short_sha}" print(describe_result) # 输出结果可以直接写入环境变量传给conan构建流程
方案优势
该方案完全不需要拉取仓库代码,接口请求耗时远低于浅克隆操作,性能更高,同时不会受浅克隆深度限制导致拿不到历史标签信息,适配所有CI构建场景。
内容的提问来源于stack exchange,提问作者elsamuko
相关产品推荐
相关产品推荐

