decathlon/release-notes-generator-action

Release Note Generator GitHub Action

镜像概述和主要用途

该GitHub Action可在里程碑关闭时自动生成发布说明，通过扫描里程碑关联的议题和拉取请求，使用https://github.com/spring-io/github-changelog-generator%E5%B7%A5%E5%85%B7%E7%94%9F%E6%88%90%E7%BB%93%E6%9E%84%E5%8C%96%E6%96%87%E6%A1%A3%E3%80%82%E9%80%82%E7%94%A8%E4%BA%8E%E9%9C%80%E8%A6%81%E5%AE%9A%E6%9C%9F%E6%B1%87%E6%80%BB%E9%A1%B9%E7%9B%AE%E5%8F%98%E6%9B%B4%E4%BF%A1%E6%81%AF%E7%9A%84%E5%9C%BA%E6%99%AF%EF%BC%8C%E9%81%BF%E5%85%8D%E9%A2%91%E7%B9%81%E5%8F%91%E5%B8%83%E9%9B%B6%E6%95%A3%E6%9B%B4%E6%96%B0%E8%AF%B4%E6%98%8E%E3%80%82

核心功能和特性

• 自动生成发布说明：里程碑关闭时触发，自动收集并整理相关议题和拉取请求
• 自定义输出配置：支持指定输出文件夹、文件名前缀、自定义文件名
• 里程碑标题集成：可使用里程碑标题（空格替换为下划线）作为文件名
• 手动触发支持：v3.1.0+版本支持通过workflow_dispatch手动触发
• 章节自定义：通过配置文件定义发布说明的章节结构和标签映射

使用场景和适用范围

• 持续部署项目：避免每次代码变更都生成发布说明，按周期（如每周、Sprint结束）汇总更新
• 团队协作沟通：向用户或团队成员定期推送清晰、完整的项目变更记录
• 文档自动化：自动生成的发布说明可用于Wiki、邮件通知、网站展示等场景

详细使用方法和配置说明

基本使用

创建GitHub Action工作流文件

在项目根目录创建 .github/workflows/release-notes.yml 文件，配置触发条件和执行步骤。

v2.0.0+版本配置示例

yaml
# 触发工作流的事件
on: 
  milestone:
    types: [closed]
name: 里程碑关闭处理
jobs:
  create-release-notes:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: 生成发布说明
      uses: docker://decathlon/release-notes-generator-action:2.0.1
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # 必须提供，用于访问GitHub API
        OUTPUT_FOLDER: temp_release_notes          # 可选，指定输出文件夹
        USE_MILESTONE_TITLE: "true"                # 可选，使用里程碑标题作为文件名

workflow_dispatch配置（v3.1.0+）

支持手动触发工作流，需添加以下配置：

yaml
on:
  milestone:
    types: [closed]
  workflow_dispatch:
    inputs:
      milestoneId:
        description: '里程碑ID'     
        required: true
        default: '1'  # 默认里程碑ID

注意：milestoneId变量名不可修改，工作流将同时响应里程碑关闭事件和手动触发。

环境变量配置说明

自定义输出文件名

使用前缀（v2.0.0+）

yaml
- name: 生成发布说明
  uses: docker://decathlon/release-notes-generator-action:2.0.1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    FILENAME_PREFIX: Sprint

输出文件名将为 Sprint_2.md（假设里程碑ID为2）。

完全自定义文件名（v2.0.0+）

yaml
- name: 生成发布说明
  uses: docker://decathlon/release-notes-generator-action:2.0.1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    FILENAME: Q3_Release

输出文件名将为 Q3_Release.md。

使用里程碑标题作为文件名

yaml
- name: 生成发布说明
  uses: docker://decathlon/release-notes-generator-action:2.0.1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    USE_MILESTONE_TITLE: "true"

若里程碑标题为"Sprint 10"，输出文件名将为 Sprint_10.md。

章节配置

通过在项目根目录创建 .github/release-notes.yml 文件自定义发布说明章节，示例：

yaml
changelog:
  sections:
  - title: "功能增强"
    labels: ["enhancement"]  # 关联议题/PR的标签
  - title: "问题修复"
    labels: ["bug"]
  - title: "文档更新"
    labels: ["documentation"]

详细配置说明可参考https://github.com/spring-io/github-changelog-generator#customizing-sections

生成文件的使用方式

生成的发布说明文件可通过后续Action步骤进行处理，例如：

• 推送到GitHub Wiki（使用https://github.com/Decathlon/wiki-page-creator-action%EF%BC%89
• 通过邮件发送给团队成员
• 发布到项目网站或内部文档系统

用户可根据需求自由扩展处理逻辑，保持对发布说明分发的完全控制。