antonyurchenko/git-release

git-release

一个GitHub Action，用于在向仓库推送新标签时创建包含资产和变更日志的GitHub Release。

!PIC

核心功能和特性

• 解析符合语义化版本（Semantic Versioning）的标签
• 上传构建产物（资产）到发布
• 为发布添加变更日志
• 支持Linux/Windows运行器
• 文件名模式匹配

使用场景和适用范围

适用于需要自动化管理GitHub Release的项目，特别是需要在推送标签时自动生成包含变更日志和构建资产的发布版本，简化版本发布流程。

使用方法和配置说明

准备工作

1. 根据keepachangelog.com规范更新CHANGELOG.md。例如：

markdown
## [3.4.0] - 2020-07-10
### Added
- 支持Glob模式
- 单元测试
- 日志版本

### Fixed
- 变更日志上下文外的边距异常
- 'release'包中的空指针异常

### Changed
- 重构JavaScript包装器

## [3.3.0] - 2020-06-27
### Added
- 包装脚本：支持Windows运行器执行

### Changed
- 从Docker改为NodeJS通过Git执行Action

[3.4.0]: https://github.com/anton-yurchenko/git-release/compare/v3.3.0...v3.4.0
[3.3.0]: https://github.com/anton-yurchenko/git-release/releases/tag/v3.3.0

2. 为提交创建符合semver.org规范的版本标签。
3. 推送标签，git-release将自动在GitHub上发布版本。
   !PIC

工作流配置

1. 设置触发条件

修改工作流以在标签推送时触发，例如：

yaml
on:
  push:
    tags:
    - 'v*'  # 或更具体的模式如'*'

2. 添加发布步骤

yaml
    - name: Release
      uses: docker://antonyurchenko/git-release:latest
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        DRAFT_RELEASE: "false"
        PRE_RELEASE: "false"
        CHANGELOG_FILE: "CHANGELOG.md"
        ALLOW_EMPTY_CHANGELOG: "false"
        ALLOW_TAG_PREFIX: "true"
      with:
        args: |
            build/*-amd64.zip

配置选项详情

Windows运行器配置

yaml
    - name: Release
      uses: anton-yurchenko/git-release@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        DRAFT_RELEASE: "false"
        PRE_RELEASE: "false"
        CHANGELOG_FILE: "CHANGELOG.md"
        ALLOW_EMPTY_CHANGELOG: "false"
        ALLOW_TAG_PREFIX: "true"
      with:
        args: |
            build\\darwin-amd64.zip
            build\\linux-amd64.zip
            build\\windows-amd64.zip

:information_source: 配置示例

注意事项

• Git标签应与变更日志版本一致（无前缀），例如标签v1.0.0对应变更日志版本1.0.0
• 该Action在Docker Hub自动构建，标签包括latest / v3 / v3.4 / v3.4.1，建议锁定主版本（如v3）而非使用latest
• 可通过将docker://antonyurchenko/git-release:latest改为anton-yurchenko/git-release@master，通过JavaScript包装器执行Action
• git-release通过模式匹配处理资产，无法验证资产是否存在

许可

MIT © 2019-present Anton Yurchenko