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

Unexpected behavior of release note generation between tags

Ouverte
#126 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
help wanted
Langage dominant
JavaScript
Étoiles
897
Forks
313
Métriques de merge des PR
Aucune PR mergée en 30 j

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
git, javascript, node.js
Domaine
release
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.