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

Provide a way to include the generated changelog file in the release

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

Description

To do a release with Gren, the workflow is:
- put a tag on a commit
- run `gren release`

After this is done, if one wants a textual `CHANGELOG.md` file, one can run `gren changelog`, which retrieves the description of the release from the repo and puts it into a file.

Then, if we want this generated `CHANGELOG.md` to be part of the repo, we add it with a commit. However, this means this file is not part of the release tarball we just made, since this new commit will come after the tag.

Could we imagine a way to be able to make a release that would include its own updated `CHANGELOG.md` file?

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par suivre les points d’entrée `gren release` et `gren changelog` et la manière dont le tarball de la release est créé. Le travail est terminé lorsqu’une release peut inclure son `CHANGELOG.md` généré dans le tarball sans nécessiter de commit ultérieur.

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

Évaluation

Stack technique
javascript, node.js
Domaine
cli, release
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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