diffplug / diffplug/spotless

Dependabot and Renovate shows wrong changelog info

Abierto
#1,048 3 comentarios 1 reacción 0 asignados Ver en GitHub
bug
Lenguaje dominante
Java
Estrellas
5.6k
Forks
559
Merge medio
1 d 14 h
PR fusionados (30 d)
43

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza examinando cómo spotless-maven-plugin publica su changelog y sus metadatos, especialmente CHANGES.md, y compáralo con el ejemplo de Dependabot en el pull request 8480. El trabajo estará terminado cuando los pull requests de actualización creados por Dependabot y Renovate muestren el changelog y los commits propios del plugin, así como la fuente correcta del changelog, en lugar de la información del proyecto raíz.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
build-system
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.