gembaadvantage/uplift

Uplift镜像说明

镜像概述

Uplift是一款基于Conventional Commits规范的语义版本控制工具，旨在通过提交信息自动生成符合语义化版本（SemVer）的版本号，简化项目发布管理流程。该工具专为持续集成（CI）环境设计，采用模块化架构，可灵活选择所需的发布功能，且基于Go语言构建，支持跨平台安装使用。

核心功能

• 利用Conventional Commits提交信息自动生成语义版本
• 模块化设计，按需启用发布周期相关功能（如版本更新、Changelog生成等）
• 严格遵循语义化版本规范（SemVer）
• 适配CI/CD流水线，易于集成到现有工作流
• 跨平台支持（基于Go语言构建）

使用场景

• CI/CD流水线中自动完成版本号更新与发布
• 团队协作项目中统一版本控制规范
• 简化开源或商业项目的发布管理流程

配置说明

可通过命令行参数或配置文件（uplift.yml）自定义工具行为，例如：

• 指定提交类型与版本更新规则的映射
• 配置版本前缀或忽略特定提交
• 自定义Changelog生成格式

详细配置文档请参考官方网站：upliftci.dev

部署示例

Docker Run命令

在项目目录中执行版本检查或发布操作：

bash
# 查看版本
docker run --rm -v $(pwd):/app gembaadvantage/uplift version

# 执行版本更新与发布
docker run --rm -v $(pwd):/app gembaadvantage/uplift release

CI集成示例（以GitHub Actions为例）

在.github/workflows/release.yml中添加以下步骤：

yaml
steps:
  - name: Checkout code
    uses: actions/checkout@v4
    with:
      fetch-depth: 0 # 需要完整历史提交记录
  
  - name: Run Uplift
    uses: docker://gembaadvantage/uplift:latest
    with:
      args: release
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}