Skip to main content

针对 Dependabot 更新优化 Java 包

通过在 pom.xml 文件中包括元数据,可以在 Dependabot 拉取请求中向用户提供更多信息,以便他们更新你的 Java 包。

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

在 pom.xml 文件中包括元数据 Dependabot

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

  • url 项目的主页,请参见 POM 参考中的更多项目信息
  • scm 项目使用的源代码管理系统的 URL,请参见 POM 参考中的 SCM
  • issueManagement 项目使用的问题管理系统的 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>

OWNERREPOSITORY 替换为项目的详细内容。

在 pom.xml 文件中省略项目元数据的影响

如果忘记包含 Dependabot 检查的 URL,则仍会创建更新 Java 包的拉取请求。 但是,拉取请求摘要中提供给用户的信息将受到限制。

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

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

其他阅读材料