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

Generating release changelog from non-master branch commit history

Aperta
#116 10 commenti 5 reazioni 0 assegnatari Vedi su GitHub
enhancement PR welcome
Lingua principale
JavaScript
Stelle
897
Fork
313
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We have a system where the latest major release is always from master branch, but we also maintain old major releases in branches such v1.x, v2.x etc, etc. If I run gren for a release from master everything works as I'd expect. The release notes for the latest major release are generated and include all the commits from master branch, but if I want to make a new oldversion.x.y release I can't work out how to make gren use the commits from the appropriate branch rather than master. I couldn't see anything in the docs: https://github-tools.github.io/github-release-notes/options.html

Is this possible and I've just overlooked the option I need?

Invoking gren like this FWIW:
```
$GREN \
--username=$USER \
--repo=$REPO \
--token=$GITHUB_TOKEN \
--data-source=commits \
--action=release \
--tags=$VERSION \
--include-messages=commits
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start with the gren release action and the options documentation linked in the issue, then trace how the provided --data-source=commits and --tags=$VERSION arguments select commit history. Done means a release from a v1.x or v2.x branch generates notes from that branch rather than master, with coverage for the documented invocation.

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

Valutazione

Stack tecnologico
javascript
Ambito
cli, release
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.