Dependabot utilise les champs url, scm et issueManagement dans les fichiers pom.xml pour créer des demandes de tirage pour les mises à jour des dépendances Java. Lorsque vous incluez ces métadonnées, les pull requests contiennent des liens vers des notes de version et des suivis de problèmes, ce qui aide les utilisateurs à mettre à jour les paquets en toute confiance.
Métadonnées dont Dependabot a besoin dans les fichiers pom.xml
Dependabot utilise les URL du projet, du système de gestion du code source et du système de gestion des problèmes pour créer le résumé des demandes de mise à jour.
- : page d’accueil du projet. Voir plus d’informations sur le projet dans la référence POM
- : URL du système de gestion du code source utilisé par le projet. Voir SCM dans la référence POM
- : URL du système de gestion des problèmes utilisé par le projet. Voir Gestion des problèmes dans la référence POM
Exemple de projet hébergé sur 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>
Impact de l’omission des métadonnées de projet à partir de fichiers pom.xml
Si vous oubliez d’inclure les URL que Dependabot recherche, des pull requests pour mettre à jour les paquets Java sont toujours créées. Toutefois, les informations accessibles aux utilisateurs dans le résumé des pull requests seront limitées.
- Référentiel de projet ou URL de gestion du code source non défini : pas de liens vers les notes de mise à jour dans les demandes de tirage Dependabot
- URL de gestion des problèmes non définie : aucun lien vers la page problèmes pour signaler des problèmes.
L’ajout de ces informations permet à Dependabot de fournir de meilleures mises à jour plus précises pour votre projet, avec des liens utiles vers les notes de publication et les suivis de problèmes.
Lectures complémentaires
- Plugin SCM pour Maven