Java Paketmetadaten für Dependabot-Updates

Fügen Sie Metadaten in die Datei pom.xml ein, um hilfreiche Links und Kontext in Dependabot Pullanforderungen für Java-Paketupdates bereitzustellen.

In diesem Artikel

Dependabot erstellt mit Hilfe der url, scm und issueManagement Felder in pom.xml Dateien Pull-Requests für Java-Abhängigkeitsupdates. Wenn Sie diese Metadaten einschließen, enthalten Pullanforderungen Links zu Versionshinweisen und Problemverfolgungen, die Benutzern helfen, Pakete mit Vertrauen zu aktualisieren.

Metadaten, die Dependabot in pom.xml-Dateien benötigt

Dependabot verwendet die URLs für das Projekt, das Quellcodeverwaltungssystem und das Fehlermanagementsystem, um die Zusammenfassung für Aktualisierungspullanforderungen zu erstellen.

  • url: Die Startseite für das Projekt. Weitere Projektinformationen finden Sie in der POM-Referenz
  • scm: Die URL des quellcodeverwaltungssystems, das vom Projekt verwendet wird. Siehe SCM in der POM-Referenz
  • issueManagement: Die URL des vom Projekt verwendeten Problemverwaltungssystems. Siehe Problemverwaltung im POM Referencex

Beispiel für ein auf GitHub

gehostetes Projekt

<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>

Auswirkungen beim Weglassen von Projekt-Metadaten in pom.xml-Dateien

Wenn du vergisst, die URLs anzugeben, nach denen Dependabot sucht, werden trotzdem Pull-Requests zur Aktualisierung von Java-Paketen erstellt. Benutzern stehen dann jedoch nur eingeschränkte Informationen in der Zusammenfassung des Pull Requests zur Verfügung.

  • URL für Projektrepository oder Quellcodeverwaltung nicht angegeben: keine Links zu Release-Notizen in Dependabot pull requests
  • URL für Problemverwaltung nicht angegeben: kein Link zur Seite zum Melden von Problemen

Indem du diese Informationen hinzufügst, kann Dependabot zusammen mit hilfreichen Links zu Versionshinweisen und Issue-Trackern bessere und vollständigere Updates für dein Projekt bereitstellen.

Weiterführende Lektüre