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

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

Aperta
#171 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
question
Lingua principale
JavaScript
Stelle
897
Fork
313
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by tracing the `gren release` and `gren changelog` entry points and how the release tarball is created. Done means a release can include its generated `CHANGELOG.md` in the tarball without requiring a later commit.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, node.js
Ambito
cli, release
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.