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

Generating release changelog from non-master branch commit history

Offen
#116 10 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement PR welcome
Vorherrschende Sprache
JavaScript
Sterne
897
Forks
313
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
cli, release
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.