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

Unexpected behavior of release note generation between tags

未關閉
#126 5 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
help wanted
主要語言
JavaScript
星號
897
分支
313
PR 合併指標
30 天內沒有已合併 PR

描述

Great tool and appreciate that you wrote this. I am trying it out and have run into an unexpected behavior.

This is probably best explained in an image, so please see the below image.
issues

Basically, the issue is that I expecting that release notes pick up commit messages between tags in the following way:
- tag 2.0.0 (another commit msg here "close issue 3")
- commit msg 1 "close issue 2"
- commit msg 2
- tag 1.0.0 ( a commit msg here: "close issue 1)

For release version 2.0.0, I expect to see:
"close issue 3"
"close issue 2"
"commit msg 2"

My testing repository is here:
https://github.com/Aperio-Group/testingstuff/settings

Here were my commands I used:
2061 git push origin v3.0.0
2062 gren release
2063 git touch adding_feature.txt
2064 touch adding_feature.txt
2065 git add adding_feature.txt
2066 git commit -m "adding a cool feature. this closes #7"
2067 touch adding_another_feature.txt
2068 git add adding_another_feature.txt
2069 git commit -m "adding another feature. this closes #8"
2070 git tag v3.0.1
2072 git push origin v3.0.1
2073 gren release

Please let me know if I'm using the tool incorrectly.

貢獻指南

開啟貢獻指南

研究方向

Reproduce the report using the listed v3.0.0 and v3.0.1 tags and the `gren release` commands, then compare the generated notes with the commits between those tags. Trace the release-note generation entry point and verify that the output includes the expected commits between tags without older-tag commits.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
git, javascript, node.js
領域
release
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

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

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