优化 Java 包以进行 Dependabot 更新

通过在您的pom.xml文件中包含元数据，您可以增强 Dependabot 拉取请求中向用户提供的有关更新 Java 包的信息。

本文内容

Dependabot 使用在pom.xml文件中定义的信息来创建拉取请求，以更新 Gradle 和 Maven 生态系统的 Java 依赖项。当您包含 Dependabot 预期的项目元数据时，拉取请求将包含指向建议的包更新的发行说明的链接以及用户可以报告任何问题的链接。此信息意味着用户可以在查看所有发行信息后自信地更新其包。

在 pom.xml 文件中包含 Dependabot 需要元数据

Dependabot 使用项目、源代码管理系统和问题管理系统的 URL 来构建更新拉取请求的摘要。

  • 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 包的拉取请求。但是，在拉取请求摘要中提供给用户的可用信息将受到限制。

  • 项目存储库或源代码管理 URL 未定义：Dependabot 拉取请求中没有指向发行说明的链接
  • 问题管理 URL 未定义：没有指向用于报告问题的页面链接。

添加此信息有助于 Dependabot 为您的项目提供更好、更准确的更新，并附带指向发行说明和问题跟踪器的有用链接。

进一步阅读