cn 我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

关于 Dependabot 版本更新

您可以使用 Dependabot 来确保您使用的包更新到最新版本。

本文内容

注: Dependabot 版本更新 目前处于测试阶段,可能会有变动。 要使用测试版功能,请在配置文件中登记,告诉 Dependabot 为您保留哪些依赖项。 详情请参阅“启用和禁用版本更新。”

关于 Dependabot 版本更新

Dependabot 负责维护您的依赖项。 您可以使用它来确保仓库自动跟上它所依赖的包和应用程序的最新版本。

通过将配置文件检入仓库,可启用 Dependabot 版本更新。 配置文件指定存储在仓库中的清单或其他包定义文件的位置。 Dependabot 使用此信息来检查过时的软件包和应用程序。 Dependabot 确定依赖项是否有新版本,它通过查看依赖的语义版本 (semver) 来决定是否应更新该版本。 对于某些软件包管理器,Dependabot 版本更新 也支持供应。 供应(或缓存)的依赖项是检入仓库中特定目录的依赖项,而不是在清单中引用的依赖项。 即使包服务器不可用,供应的依赖项在生成时也可用。 Dependabot 版本更新 可以配置为检查为新版本供应的依赖项,并在必要时更新它们。

当 Dependabot 发现过时的依赖项时,它会发起拉取请求以将清单更新到依赖项的最新版本。 对于供应和依赖项,Dependabot 提出拉取请求以直接将过时的依赖项替换为新版本。 检查测试是否通过,查看拉取请求摘要中包含的更改日志和发行说明,然后合并它。 更多信息请参阅“启用和禁用版本更新”。

如果启用安全更新,Dependabot 还会发起拉取请求以更新易受攻击依赖项。 更多信息请参阅“关于 Dependabot 安全更新”。

Dependabot 和所有相关功能受 GitHub 服务条款管辖。

Dependabot 拉取请求的频率

在配置文件中指定检查每个生态系统的新版本的频率:每日、每周或每月。

首次启用版本更新时,您可能有很多过时的依赖项,其中一些可能为许多落后于最新版本的版本。 Dependabot 将在其启用后立即检查过时的依赖项。 根据您配置更新的清单文件的数量,您可能会在添加配置文件后几分钟内看到新的版本更新拉取请求。

为使拉取请求保持可管理和易于审查,Dependabot 最多将提出五个拉取请求,以便开始将依赖项更新至最新版本。 如果您在下次预定更新之前合并第一批拉取请求中的一些请求,则接下来的拉取请求最多可以打开五个(您可以更改此限制)。

如果您启用了安全更新,有时会看到额外的安全更新拉取请求。 这些由默认分支上依赖项的 Dependabot 警报所触发。 Dependabot 自动提出拉取请求以更新有漏洞的依赖项。

支持的仓库和生态系统

您可以为包含其中一个受支持包管理器的依赖项清单或锁定文件的仓库配置版本更新。 对于某些软件包管理器,您也可以配置依赖项的供应。 更多信息请参阅“依赖项更新的配置选项。”

When running security or version updates, some ecosystems must be able to resolve all dependencies from their source to verify that updates have been successful. If your manifest or lock files contain any private dependencies, Dependabot must be able to access the location at which those dependencies are hosted. Organization owners can grant Dependabot access to private repositories containing dependencies for a project within the same organization. For more information, see "Managing security and analysis settings for your organization."

Currently, Dependabot version updates doesn't support manifest or lock files that contain any dependencies hosted in private registries, or in private GitHub repositories that belong to a different organization than the dependent project. 此外,Dependabot 不支持所有包管理器的 GitHub 私有依赖项。 详见下表。

下表显示对于每个包管理器,Dependabot 是否支持:私有 GitHub 仓库中的依赖项,以及供应的依赖项。

包管理器私有 GitHub 仓库供应
Bundler: bundler
Cargo: cargo
Composer: composer
Docker: docker
Elixir:hex
Elm: elm
Git 子模块:gitsubmodule
GitHub 操作:github-actions
Go 模块:gomod
Gradle: gradle
Maven: maven
Mix: mix
npm: npm
NuGet: nuget
pip: pip
Terraform: terraform

:Dependabot 也支持以下软件包管理器:

-yarn(仅限 v1)(指定 npm

-.gradle.kts 文件,用于 Kotlin 项目(指定 gradle

-pipenvpip-compilepoetry(指定 pip

例如,如果您使用 poetry 来管理 Python 依赖项,并且希望 Dependabot 监控新版本的依赖项清单文件,请在 dependabot.yml 文件中使用 package-ecosystem: "pip"

如果您的仓库已使用集成进行依赖项管理,则在启用 Dependabot 前需要禁用此集成。 更多信息请参阅“关于集成”。

关于 Dependabot 版本更新通知

您可以在 GitHub 上过滤通知以显示 Dependabot 版本更新。 更多信息请参阅“从收件箱管理通知”。

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。