update-terraform-lockfile

README

update-terraform-lockfile

A GitHub Action which updates the Terraform lockfile

Note: This project has been deprecated and will no longer be maintained since Dependabot now updates Terraform lockfiles. https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#terraform

Features

• Updates the Terraform lockfile automatically
• Opens a pull request if updates are available

Example Usage

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - uses: hashicorp/setup-terraform@v1.3.2
        with:
          terraform_version: 1.1.4
          terraform_wrapper: false

      - uses: champ-oss/update-terraform-lockfile
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

Token

By default the GITHUB_TOKEN should be passed to the actions/checkout step as well as this action (see example usage). This is necessary for the action to be allowed to push changes to a branch as well as open a pull request.

Parameters

Parameter	Required	Description
token	false	GitHub Token or PAT
target-branch	false	Target branch for pull request
pull-request-branch	false	Branch to push changes
user	false	Git username
email	false	Git email
commit-message	false	Commit message to use

Contributing