plus3it/dependabot-terraform-action

dependabot-terraform-action

概述和主要用途

dependabot-terraform-action是一个GitHub Action，提供https://github.com/dependabot/%E7%9A%84%E5%8A%9F%E8%83%BD%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%9B%B4%E6%96%B0%E9%87%87%E7%94%A8HCL 2.0（Terraform 0.12+）语法的Terraform文件依赖。由于官方dependabot当时尚未正式支持HCL 2.0，该Action应运而生，以满足社区对Terraform 0.12+项目依赖自动更新的需求。

核心功能和特性

• HCL 2.0支持：兼容Terraform 0.12及以上版本的HCL语法
• 依赖检查与更新：自动检测Terraform文件中的依赖更新
• PR自动创建：更新依赖后自动创建Pull Request
• 多目录支持：可指定多个相对仓库根目录的路径进行检查
• 自定义目标分支：支持指定PR的目标分支
• 灵活认证：支持配置GitHub token用于仓库操作和依赖检查

使用场景和适用范围

适用于使用Terraform 0.12+版本的项目，尤其是依赖GitHub仓库模块的场景。适合通过定时任务（如每日）运行，以保持Terraform依赖项的最新状态，减少手动更新依赖的工作量。

使用方法和配置说明

输入参数

使用示例

基本示例

以下示例配置每日6点运行Action，检查并更新Terraform依赖：

yaml
name: Update terraform dependencies
on:
  schedule:
    # 每日6点运行
    - cron:  '0 6 * * *'

jobs:
  dependabot-terraform:
    runs-on: ubuntu-latest
    steps:
      - name: update terraform dependencies
        uses: patrickjahns/dependabot-terraform-action@v1
        with:
          github_dependency_token: ${{ secrets.DEPENDENCY_GITHUB_TOKEN }}

许可证

本项目的脚本和文档以MIT License发布。