Optimización de paquetes de Java para actualizaciones de Dependabot

Al incluir metadatos en el archivo pom.xml, puedes mejorar la información disponible para los usuarios en solicitudes de cambios de Dependabot para actualizar los paquetes de Java.

En este artículo

Dependabot usa la información definida en archivos pom.xml para crear solicitudes de cambios para actualizar las dependencias de Java para los ecosistemas de Gradle y Maven. Cuando incluyes los metadatos del proyecto que Dependabot espera, las solicitudes de cambios contienen vínculos a las notas de la versión de la actualización del paquete sugerido y un vínculo donde los usuarios pueden notificar cualquier problema. Esta información significa que los usuarios pueden actualizar sus paquetes con confianza después de revisar toda la información de versión.

Inclusión de las necesidades de Dependabot de metadatos en archivos pom.xml

Dependabot usa las direcciones URL del proyecto, el sistema de administración de código fuente y el sistema de administración de propuestas para compilar el resumen de las solicitudes de cambios de actualizaciones.

  • url la página principal del proyecto. Consulta Más información del proyecto en la referencia de POM.
  • scm la dirección URL del sistema de administración de código fuente que el proyecto usa. Consulta SCM en la referencia de POM.
  • issueManagement la dirección URL del sistema de administración de propuestas que el proyecto usa. Consulta Administración de propuestas en la referencia de POM.

Ejemplo de un proyecto hospedado en GitHub

<project>
  <url>https://github.com/OWNER/REPOSITORY</url>
  <scm>
    <url>https://github.com/OWNER/REPOSITORY</url>
  </scm>
  <issueManagement>
    <url>https://github.com/OWNER/REPOSITORY/issues</url>
  </issueManagement>
</project>

Reemplaza OWNER y REPOSITORY por el detallado del proyecto.

Impacto de omitir los metadatos del proyecto de los archivos de pom.xml

Si olvidas incluir las direcciones URL que Dependabot comprueba, las solicitudes de cambios para actualizar los paquetes de Java se siguen creando. Sin embargo, la información disponible para los usuarios en el resumen de la solicitud de cambios será limitada.

  • **Repositorio de Project o dirección URL de administración de código fuente sin definir: ** no hay vínculos a notas de la versión de solicitudes de cambios de Dependabot
  • Dirección URL de administración de incidencias sin definir: no hay ningún vínculo a la página de incidencias para notificar problemas.

Agregar esta información ayuda a Dependabot a proporcionar actualizaciones mejores y más precisas para el proyecto. Incluye vínculos útiles a notas de la versión y rastreadores de propuestas.

Información adicional