apache / apache/datafusion

[DISCUSS] Use semantic PR titles to help with change log generation?

Offen
#5,601 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
development-process
Vorherrschende Sprache
Rust
Sterne
9.3k
Forks
2.4k
Ø Merge
3 T. 11 Std.
Gemergte PRs (30 T.)
360

Beschreibung

We have been using github-changelog-generator [1] to generate changelogs for the Rust projects for some time now. It has served us well but is no longer workable, at least for DataFusion. This tool seems to pull down the entire project history using the GitHub API and we had to artificially slow it down to avoid hitting API rate limits, and it is now unusable due to the number of issues and PRs in this repo.

This weekend, I built a much simpler changelog generator in Python [2], that I am now using for the projects that I am the release manager for (datafusion, datafusion-python, ballista). It has almost the same functionality that we were getting from the previous generator, but takes less than a minute to run, compared to 30+ minutes for the old generator. It only hits the GitHub API for information about commits and pull requests in the release being documented, rather than accessing the entire project history.

I followed the same approach of using GitHub labels to categorize PRs (enhancements, bug fixes, docs, etc) but this requires a small amount of manual effort to add those labels and re-generate the changelog.

I noticed that some contributors are already prefixing PR titles with "feat:", "feature:", "fix:", "docs:", etc. I plan on updating the changelog generator to recognize these prefixes as well, to help automate my job.

I wonder if it is worth formalizing these "semantic titles" more, and maybe having CI enforce them. It would improve the quality of our changelogs and reduce the burden on release managers.

I would appreciate any feedback on this idea.

Thanks,

Andy.

[1] https://github.com/github-changelog-generator/github-changelog-generator
[2] https://github.com/andygrove/changelog-genie

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, das verlinkte changelog-genie-Projekt zu lesen und es mit github-changelog-generator zu vergleichen, um den aktuellen Release-Workflow zu verstehen. Sieh dir anschließend die Diskussion über semantische PR-Titel, labelbasierte Kategorien und eine mögliche Durchsetzung per CI an. Erledigt wäre die Aufgabe, wenn ein entschiedener, dokumentierter Ansatz statt eines ergebnisoffenen Vorschlags vorliegt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
github, python
Bereich
release, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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