Dependabot更新のJavaパッケージメタデータ

          `pom.xml` ファイルにメタデータを含めて、Dependabot におけるJavaパッケージ更新のプルリクエストに役立つリンクやコンテキストを提供します。

この記事の内容

Dependabot は、url、scm、および issueManagement ファイルの pom.xml フィールドを使用して、Java依存関係の更新に対するプル要求を作成します。 このメタデータを含めると、プル要求にはリリース ノートと問題トラッカーへのリンクが含まれるため、ユーザーはパッケージを確実に更新できます。

Dependabot が pom.xml ファイルで必要とするメタデータ

Dependabot は、プロジェクトの URL、ソース コード管理システム、issue 管理システムを使って、更新 pull request の概要を作成します。

  • : プロジェクトのホーム ページ。 POM リファレンスの プロジェクト情報の詳細 を参照してください
  • : プロジェクトによって使用されるソース コード管理システムの URL。 POM リファレンスの SCM を参照してください
  • : プロジェクトで使用される問題管理システムの URL。 POM リファレンスの 問題管理 を参照してください

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>

pom.xml ファイルからプロジェクト メタデータを省略した場合の影響

Dependabot がチェックする URL を忘れても、Java パッケージを更新するためのプル要求は作成されます。 ただし、pull request の概要でユーザーが使用できる情報は制限されます。

  • プロジェクトのポジトリまたはソース コード管理 URL が定義されていない: Dependabot の pull request にリリース ノートへのリンクは含まれません
  • issue 管理 URL が定義されていない: 問題を報告するための issue ページへのリンクは含まれません。

この情報を追加すると、Dependabot によって、プロジェクトのより正確な更新が提供され、リリース ノートと issue トラッカーへの便利なリンクが組み込まれます。

詳細については、次を参照してください。

  • Maven SCM プラグイン