search

github-tools / github-release-notes

Node module to create a release or a changelog from a tag and uses issues or commits to creating the release notes.
https://github-tools.github.io/github-release-notes/
GNU General Public License v3.0
880 stars 325 forks source link

Incorrect logic in release note creation #282

Open patrickallaert opened 3 years ago

patrickallaert commented 3 years ago

Hi,

I have used gren for both creating changelog file and generating release notes on the GH releases and have the same wrong results in both cases:

# Changelog

## v1.0.7 (29/09/2020)
*No changelog for this release.*

---

## v1.0.6 (29/09/2020)
*No changelog for this release.*

---

## v1.0.5 (29/09/2020)
*No changelog for this release.*

---

## v1.0.4 (29/09/2020)
*No changelog for this release.*

---

## v1.0.3 (29/09/2020)
*No changelog for this release.*

---

## v1.0.2 (29/09/2020)
*No changelog for this release.*

---

## v1.0.1 (29/09/2020)
*No changelog for this release.*

---

## v1.0.0 (29/09/2020)
- List of all the 95 PRs we have.

So instead of spreading the 95 PRs in their correct releases, they have all been linked to v1.0.0 (which should just have a few).

I guess this is because the tags/releases have not been created at the time of the commit they are referring to. They have all been created today Sep 29th 2020, but each of them correctly points to the right sha1.

If that is the case, I think that being time-based is not a very robust approach, however it should at least be based on the date of the commit the tag is referring to and not the tag's date.

bjhartin commented 3 years ago

:+1:

alexcanessa commented 3 years ago

Good point. This is going to the Massive refactor milestone :)

cjbarth commented 2 years ago

@patrickallaert Do the changes I made in my fork fix your problem?

https://github.com/cjbarth/github-release-notes/releases/tag/0.18.0