github-tools / github-tools/github-release-notes
Generating release changelog from non-master branch commit history
- 主要语言
- JavaScript
- 星标
- 897
- 派生
- 313
- PR 合并指标
- 30 天内没有已合并 PR
描述
We have a system where the latest major release is always from master branch, but we also maintain old major releases in branches such v1.x, v2.x etc, etc. If I run gren for a release from master everything works as I'd expect. The release notes for the latest major release are generated and include all the commits from master branch, but if I want to make a new oldversion.x.y release I can't work out how to make gren use the commits from the appropriate branch rather than master. I couldn't see anything in the docs: https://github-tools.github.io/github-release-notes/options.html
Is this possible and I've just overlooked the option I need?
Invoking gren like this FWIW:
```
$GREN \
--username=$USER \
--repo=$REPO \
--token=$GITHUB_TOKEN \
--data-source=commits \
--action=release \
--tags=$VERSION \
--include-messages=commits
```
贡献指南
调研方向
Start with the gren release action and the options documentation linked in the issue, then trace how the provided --data-source=commits and --tags=$VERSION arguments select commit history. Done means a release from a v1.x or v2.x branch generates notes from that branch rather than master, with coverage for the documented invocation.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- cli, release
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100