Dependabot の更新のための Java パッケージの最適化

pom.xml ファイルにメタデータを含めると、Java パッケージを更新するためにユーザーが Dependabot の pull request で使用できる情報を強化できます。

この記事の内容

Dependabot は、pom.xml ファイルで定義されている情報を使って、Gradle と Maven のエコシステム用に Java 依存関係を更新する pull request を作成します。 Dependabot が期待するプロジェクトメタデータを含めると、pull request には、推奨されるパッケージ更新プログラムのリリースノートへのリンクと、ユーザーが issue を報告できるリンクが含まれます。この情報は、すべてのリリース情報を確認した後、ユーザーが自信を持ってパッケージを更新できることを意味します。

Dependabot で必要なメタデータを pom.xml ファイルに含める

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

url: プロジェクトのホームページ。POM リファレンスの「その他のプロジェクト情報」を参照してください
scm: プロジェクトで使われるソースコード管理システムの URL。POM リファレンスの「SCM」を参照してください
issueManagement: プロジェクトで使われる issue 管理システムの URL。POM リファレンスの「issue の管理」を参照してください

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>

OWNER と REPOSITORY を、プロジェクトの詳細に置き換えます。

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

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

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

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

参考資料

Maven SCM プラグイン