kirknorthrop/concourse-git-semver-tag-resource

Git Semver Tag Resource

镜像概述和主要用途

Git Semver Tag Resource是一个Concourse资源，用于通过Git标签管理仓库版本号。概念上基于https://github.com/concourse/semver-resource%EF%BC%8C%E4%BD%86%E4%BB%85%E4%BE%9D%E8%B5%96Git%E4%B8%94%E4%B8%93%E6%B3%A8%E4%BA%8E%E6%A0%87%E7%AD%BE%E8%80%8C%E9%9D%9E%E4%BB%93%E5%BA%93%E4%B8%AD%E7%9A%84%E6%96%87%E4%BB%B6%E3%80%82%E5%AE%83%E6%94%AF%E6%8C%81%E5%9F%BA%E4%BA%8EGit%E6%8F%90%E4%BA%A4%E6%B6%88%E6%81%AF%E8%87%AA%E5%8A%A8%E6%9B%B4%E6%96%B0%E7%89%88%E6%9C%AC%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8ECI/CD%E6%B5%81%E7%A8%8B%E4%B8%AD%E7%9A%84%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86%E5%9C%BA%E6%99%AF%E3%80%82

核心功能和特性

• 通过Git标签追踪和管理版本号
• 支持语义化版本控制（major/minor/patch）
• 基于提交消息自动判断版本更新类型（[breaking]触发major，[patch]触发patch）
• 支持预发布版本（pre）管理，可切换预发布类型并重置版本号
• 提供原子化版本更新操作，确保版本变更的一致性
• 支持SSH和HTTP(S)两种Git认证方式

使用场景和适用范围

适用于Concourse CI/CD管道中需要版本管理的项目，特别是：

• 需要通过Git标签追踪版本历史的项目
• 希望基于提交消息自动更新版本的团队
• 需要语义化版本控制的软件项目
• 需要管理预发布版本的开发流程

安装

在管道配置的resource_types部分添加以下内容以使用此资源：

yaml
resource_types:
- name: concourse-git-semver-tag
  type: docker-image
  source:
    repository: laurentverbruggen/concourse-git-semver-tag-resource

源配置

参数说明

配置示例

yaml
resources:
- name: version
  type: concourse-git-semver-tag
  source:
    uri: git@github.com:concourse/concourse.git
    branch: version
    private_key: {{concourse-repo-private-key}}

使用方法

版本更新流程示例

分步更新（get后put）

yaml
plan:
- get: version
  params: {bump: minor}
- task: a-thing-that-needs-a-version
- put: version
  params: {file: version/number}

原子化更新（直接put）

yaml
plan:
- put: version
  params: {bump: minor}
- task: a-thing-that-needs-a-version

行为说明

check: 报告当前版本号

通过扫描Git仓库的标签检测新版本。如果尚无标签，则返回initial_version。

in: 提供版本文件，可选更新版本

将版本号以number文件形式提供给构建。可配置本地更新版本，便于提前获取构建 artifacts 的最终版本。

参数

• bump 和 pre: 可选，详见版本更新语义

注意：bump和pre不会更新版本资源，仅修改提供给构建的版本。需显式指定输出来实际更新版本。

out: 设置版本或更新当前版本

可通过文件内容设置版本，或通过更新策略更新当前版本。如果没有当前版本，将基于initial_version进行更新。

参数

必须指定以下之一：

• file: 可选，包含要设置的版本号的文件路径
• bump 和 pre: 可选，详见版本更新语义

使用bump和/或pre时，版本更新将以原子方式执行。

版本更新语义

in和out操作均支持通过bump和pre参数进行语义化版本更新。

bump参数

可选（默认：patch），语义化版本更新类型，必须为以下值之一：

• major: 主版本号更新，例如 1.0.0 -> 2.0.0
• minor: 次版本号更新，例如 0.1.0 -> 0.2.0
• patch: 补丁版本号更新，例如 0.0.1 -> 0.0.2
• auto: 分析HEAD与当前版本间的提交消息，默认更新次版本号，除非提交包含：
  • [breaking]: 更新主版本号
  • [patch]: 更新补丁版本号

注意：如果当前版本是预发布版本且未定义pre，上述任何更新都将生成正式版本，例如 1.0.0-rc.1 -> 1.0.0

pre参数

可选，更新为预发布版本（如rc或alpha）或更新现有预发布版本：

• 如果版本已是匹配此值的预发布版本，则递增预发布号
• 如果版本是其他类型的预发布版本（如alpha vs beta），则切换类型并重置预发布号为0
• 如果版本不是预发布版本，则添加预发布类型并从0开始