gunosy/ci-git-pr-release

ci-git-pr-release Docker镜像文档

镜像概述

ci-git-pr-release是git-pr-release工具的Docker化版本，该工具用于通过Git Pull Request (PR) 实现发布管理流程。本镜像将git-pr-release打包为容器化应用，方便在CI/CD环境中快速集成和使用，无需手动配置依赖环境。

核心功能与特性

• PR发布自动化：自动创建用于发布的Pull Request，包含版本更新信息
• 发布说明生成：基于Git提交历史自动生成发布说明内容
• CI/CD集成友好：轻量级设计，可直接集成到各类CI/CD流水线（如GitHub Actions、GitLab CI等）
• 简化版本管理：通过PR流程可视化版本发布过程，便于团队协作和代码审查

使用场景与适用范围

• 采用Git工作流（如GitHub Flow、GitLab Flow）的开发团队
• 需要通过Pull Request进行版本发布管理的项目
• 希望自动化生成发布说明和版本更新PR的CI/CD流程
• 中小型项目的轻量级发布管理需求

使用方法与配置说明

基本使用（docker run）

bash
docker run -v /path/to/your/git/repo:/workspace \
  -e GITHUB_TOKEN=your_github_token \
  -e REPO_OWNER=your_username \
  -e REPO_NAME=your_repo \
  -e BASE_BRANCH=main \
  -e HEAD_BRANCH=release \
  ci-git-pr-release

环境变量配置

docker-compose配置示例

yaml
version: '3'
services:
  pr-release:
    image: ci-git-pr-release
    volumes:
      - ./your-git-repo:/workspace
    environment:
      - GITHUB_TOKEN=${GITHUB_TOKEN}
      - REPO_OWNER=your-org
      - REPO_NAME=your-project
      - BASE_BRANCH=main
      - HEAD_BRANCH=release/v1.0.0
      - PR_TITLE=Release v1.0.0

注意事项

1. 确保挂载的Git仓库目录包含完整的Git历史和配置
2. GitHub令牌需具备足够权限（至少需要public_repo或repo范围）
3. 首次使用前建议在本地测试PR创建逻辑，避免CI环境中出现配置错误
4. 支持自定义发布说明模板，可通过挂载模板文件或设置PR_BODY环境变量实现