用于 Dependabot 更新的 Java 软件包元数据

在 pom.xml 文件中包括元数据，以便在 Dependabot 拉取Java包更新请求中提供有用的链接和上下文。

本文内容

Dependabot 使用 pom.xml 文件中的 url、scm 和 issueManagement 字段来创建Java依赖项更新的拉取请求。 包含此元数据时，拉取请求将包含发行说明和问题跟踪器的链接，帮助用户放心地更新包。

在 pom.xml 文件中，Dependabot 需要的元数据

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

  • ：项目的主页。 请查看 POM 参考中的更多项目信息
  • ：项目使用的源代码管理系统的 URL。 请参阅 POM 参考中的 SCM
  • ：项目使用的问题管理系统的 URL。 请参阅 POM Referencex 中的议题管理

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

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

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

延伸阅读

  • Maven SCM 插件