Release tool: provide an indication when CHANGELOG entry has no content
- Vorherrschende Sprache
- JavaScript
- Sterne
- 77
- Forks
- 83
- Ø Merge
- 2 T. 5 Std.
- Gemergte PRs (30 T.)
- 37
Beschreibung
One of the steps of the release process is CHANGELOG entry generation. Sometimes the entry might have no content (for example when only docs/refactoring changes were merged since the previous release) and the entry looks like this:
```
# 13.0.2 (2021-11-17)
## Special Thanks
Andrew Kushnir, Armen Vardanyan, Dylan Hunn, Joey Perrott, Martin von Gagern, Paul Gschwendtner, Pete Bacon Darwin, Ramesh Thiruchelvam, dario-piotrowicz and fusho-takahashi
```
Release instructions used to suggest that Caretakers should add the following phrase in this case:
```
This release contains various API docs improvements.
```
The proposal is to warn a Caretaker that actions need to be taken to update the CHANGELOG.
P.S.: issue #263 also results in adding the same update to the PR generated against the master branch during the patch release.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, den Schritt zur Generierung des CHANGELOG-Eintrags des Release-Tools zu lokalisieren, und reproduziere ein Release, dessen Eintrag nur die Überschrift und den besonderen Dank enthält. Bestätige, dass die Warnung den Caretaker auffordert, den CHANGELOG zu aktualisieren, einschließlich des gegen den master branch generierten patch-release PR; als erledigt gilt dies, wenn beide Fälle diesen Hinweis enthalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript
- Bereich
- release
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100