github-tools / github-tools/github-release-notes

Generating release changelog from non-master branch commit history

未關閉
#116 10 則留言 5 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement PR welcome
主要語言
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

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。