aevea/release-notary

Release Notary

Release Notary 是一款基于 Conventional Commit（规范提交） 标准生成发布说明的工具，支持将生成的发布说明发布到 Github 和 Gitlab 平台，同时可通过 Slack 集成发送通知。生成的发布说明会追加到现有发布文本中，不会影响已有的重要公告内容。

⚠️ 目前处于实验阶段。如有任何问题，请反馈 ⚠️

核心功能与特性

• 基于规范提交标准：遵循 Conventional Commit 规范解析提交信息，自动生成结构化的发布说明
• 多平台支持：目前支持 Github 和 Gitlab 平台发布
• Slack 集成：可通过 Incoming webhook 将发布说明发送到 Slack 频道
• 兼容性设计：生成的发布说明会追加到现有发布文本中，不覆盖已有内容
• 灵活部署：支持通过 Github Actions、Gitlab CI 或二进制文件运行

使用场景与适用范围

• 自动化 CI/CD 流程中，在版本标签推送时自动生成并发布发布说明
• 采用 Conventional Commit 规范的项目，需要标准化、自动化发布文档管理
• 需要向团队实时同步版本发布信息的开发团队（通过 Slack 集成）

环境配置说明

Github

环境变量

说明：在 Github Actions 中，GITHUB_REPOSITORY 会自动以正确格式提供，无需显式配置；GITHUB_TOKEN 也会自动提供正确的访问权限，其他环境下需手动生成并添加到流水线。

Gitlab

环境变量

在 Gitlab CI 中，除 GITLAB_TOKEN 外，其他变量均为预定义变量，详情可参考 Gitlab 文档。

Slack

Slack 集成通过 Incoming webhook 将发布说明发送到指定频道，配置详情可参考 Slack 文档。

环境变量

使用方法

Github Actions

使用 actions/checkout@v2

actions/checkout@v2 默认仅拉取最新提交，需配置 fetch-depth: 0 获取完整提交历史。该工作流应仅在标签推送时运行。

示例工作流文件：

yaml
name: Release
on:
  push:
    tags:
      - v*
jobs:
  release-notes:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Release Notary Action
        uses: docker://aevea/release-notary:0.9.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

使用 actions/checkout@v1

该工作流应仅在标签推送时运行，示例触发条件：

yaml
on:
  push:
    tags:
      - "v*"

检出代码（需获取完整提交历史和主分支）：

yaml
- name: Check out code into the Go module directory
  uses: actions/checkout@v1

运行 Release Notary（需显式配置 Github Token）：

yaml
- name: Release Notary Action
  uses: aevea/release-notary@v0.2.0  # 替换为当前版本
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Gitlab CI

示例配置：

yaml
release:
  stage: release
  variables:
    GITLAB_TOKEN: $RELEASE_TOKEN
  image:
    name: aevea/release-notary:latest
    entrypoint: [""]
  script:
    - release-notary publish
  only:
    - tags

使用二进制文件

下载并运行（将 v0.0.2 替换为当前版本）：

bash
# 下载二进制文件
curl -L -O https://github.com/aevea/release-notary/releases/download/v0.0.2/release-notary_v0.0.2_Linux_x86_64.tar.gz

# 解压
tar -xzf release-notary_v0.0.2_Linux_x86_64.tar.gz

# 配置环境变量
export GITHUB_TOKEN=yourtoken
export GITHUB_REPOSITORY=owner/repo

# 执行发布
./release-notary publish