diffplug / diffplug/spotless

Dependabot and Renovate shows wrong changelog info

Offen
#1,048 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
bug
Vorherrschende Sprache
Java
Sterne
5.6k
Forks
559
Ø Merge
1 T. 14 Std.
Gemergte PRs (30 T.)
43

Beschreibung

Many projects use dependabot to manage version updates of dependencies. It helps them to keep up to date with new versions, but also to understand what changed between versions. When a new version is available, a pull request with the related change is created. It's body (i.e. description) contains a changelog and list of commits between the different versions. For spotless-maven-plugin this does not work correctly, because it uses the changelog and commits of the root project.

For example https://github.com/camunda-cloud/zeebe/pull/8480 shows that it updates spotless-maven-plugin from 2.17.7 to 2.18.0, but the changelog shows the changes of the root project up to version `2.18.0`, instead of the changes of the maven-plugin. In addition, its shows the wrong changelog as source:
> Sourced from [spotless-maven-plugin's changelog](https://github.com/diffplug/spotless/blob/main/CHANGES.md)

Looking at the [dependabot issues about changelog](https://github.com/dependabot/dependabot-core/issues?q=is%3Aissue+is%3Aopen+changelog), this seems to be a common problem. However, it also looks like the dependabot team does not intend to change anything for it. So, I think spotless should improve its setup to correct dependabot's failure to deal with this, because it would help existing users of spotless, to learn about the changes in new versions.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit zu untersuchen, wie das spotless-maven-plugin sein Changelog und seine Metadaten veröffentlicht, insbesondere CHANGES.md, und vergleiche dies mit dem Dependabot-Beispiel in Pull Request 8480. Die Arbeit ist abgeschlossen, wenn von Dependabot und Renovate erstellte Pull Requests das eigene Changelog und die eigenen Commits des Plugins sowie die korrekte Changelog-Quelle anzeigen, anstatt die Informationen des Root-Projekts.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
build-system
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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