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

Unexpected behavior of release note generation between tags

Open
#126 5 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
JavaScript
Stars
897
Forks
313
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, javascript, node.js
Domain
release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.