yaml
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
这段代码是 Dependabot 的配置文件 (通常放在 .github/dependabot.yml
中),它的作用是 自动化管理 GitHub Actions 的依赖更新。以下是逐行解析:
代码解析
yaml
version: 2 # 使用 Dependabot 的 v2 配置格式
updates: # 定义要更新的依赖类型
- package-ecosystem: "github-actions" # 指定管理 GitHub Actions
directory: "/" # 扫描仓库根目录下的所有工作流文件
schedule:
interval: "weekly" # 每周自动检查一次更新
实际效果
当这个配置生效后:
-
每周自动扫描
Dependabot 会检查您仓库中所有
.github/workflows/*.yml
文件里使用的 Actions(如actions/checkout@v2
) -
发现更新时
如果检测到新版本(如
actions/checkout@v4
),会自动:- 创建 Pull Request
- 在 PR 中显示版本差异和更新日志
- 添加
dependencies
标签
-
更新示例
diff- uses: actions/checkout@v2 + uses: actions/checkout@v4
扩展配置建议
如果想更精确控制,可以补充:
yaml
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "monday" # 固定每周一检查
labels: ["deps"] # 自定义 PR 标签
reviewers: ["team1"] # 指定审查人
commit-message:
prefix: "chore" # 提交消息加前缀
注意事项
-
需要仓库权限
- 仓库需启用 GitHub Advanced Security
- 需要管理员权限添加配置文件
-
首次运行
配置后首次检查可能需要 24 小时触发
-
查看状态
在仓库的 Insights → Dependency graph → Dependabot 可查看更新记录
对比其他配置
配置项 | 作用 |
---|---|
package-ecosystem: "npm" |
管理 npm 依赖 |
directory: "/src" |
只扫描指定目录 |
interval: "daily" |
每天检查 |
当前的配置是最基础的 GitHub Actions 每周自动更新方案,适合需要稳定更新的场景。