everpeace/release-drafter

Release Drafter 镜像说明

镜像概述

Release Drafter是基于Probot构建的自动化工具，可在拉取请求（PR）合并到指定分支时实时更新发布笔记草稿。它支持通过配置文件自定义发布内容的格式、分类规则和版本号生成方式，帮助团队高效规范版本发布流程。

核心功能

1. 自动跟踪合并到目标分支的PR，动态更新发布草稿
2. 支持自定义发布笔记模板（标题、标签、内容结构）
3. 按PR标签分类变更内容（如功能新增、Bug修复、维护优化）
4. 自动生成语义化版本号（补丁、Minor、Major版本）
5. 支持排除特定标签的PR，过滤无关内容
6. 提供正则替换规则，可修改生成内容（如链接CVE编号）

使用场景

• 开源项目或企业内部项目的版本发布管理
• 需要规范化发布笔记格式的团队
• 希望自动化生成变更日志的开发流程

配置说明

基础配置

在仓库的.github目录下创建release-drafter.yml文件，示例配置：

yaml
template: |
  ## 变更内容
  $CHANGES
name-template: 'v$NEXT_PATCH_VERSION'
tag-template: 'v$NEXT_PATCH_VERSION'
categories:
  - title: '🚀 新功能'
    labels: ['feature', 'enhancement']
  - title: '🐛 Bug修复'
    labels: ['fix', 'bugfix']
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'

关键配置项

• template：必填，发布笔记正文模板，支持$CHANGES等变量
• name-template：发布名称模板，如v$NEXT_PATCH_VERSION
• categories：按PR标签分类变更内容
• exclude-labels：排除特定标签的PR
• replacers：正则替换规则，用于修改生成内容

Docker部署示例

开发环境运行（Docker Compose）

1. 克隆项目仓库：git clone https://github.com/release-drafter/release-drafter.git
2. 进入项目目录，创建docker-compose.yml：

yaml
version: '3'
services:
  app:
    build: .
    environment:
      - NODE_ENV=development
    volumes:
      - .:/app

3. 运行测试：docker-compose run --rm app npm test
4. 启动本地服务：docker-compose run --rm app npm run dev
5. 访问localhost:3000获取GitHub App安装指引，即可测试本地功能