https://github.com/dflook/terraform-fmt

GitHub action to fix formatting of terraform files
https://github.com/dflook/terraform-fmt

actions devops github-action github-actions terraform

Last synced: about 1 month ago
JSON representation

GitHub action to fix formatting of terraform files

• Host: GitHub
• URL: https://github.com/dflook/terraform-fmt
• Owner: dflook
• Created: 2020-07-05T22:52:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T19:56:28.000Z (7 months ago)
• Last Synced: 2024-05-29T10:47:50.510Z (7 months ago)
• Topics: actions, devops, github-action, github-actions, terraform
• Homepage:
• Size: 38.1 KB
• Stars: 15
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# terraform-fmt action

This is one of a suite of Terraform related actions - find them at [dflook/terraform-github-actions](https://github.com/dflook/terraform-github-actions).

This action uses the `terraform fmt -recursive` command to reformat files in a directory into a canonical format.

## Inputs

* `path`

  Path containing Terraform files

  - Type: string

  - Optional

  - Default: The action workspace

* `workspace`

  Terraform workspace to inspect when discovering the Terraform version to use, if not otherwise specified. 

  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.

  - Type: string

  - Optional

* `backend_config`

  List of Terraform backend config values, one per line. This is used for discovering the Terraform version to use, if not otherwise specified. 

  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.

  ```yaml

  with:

    backend_config: token=${{ secrets.BACKEND_TOKEN }}

  ```

  - Type: string

  - Optional

* `backend_config_file`

  List of Terraform backend config files to use, one per line. This is used for discovering the Terraform version to use, if not otherwise specified. 

  See [dflook/terraform-version](https://github.com/dflook/terraform-github-actions/tree/main/terraform-version#terraform-version-action) for details.

  Paths should be relative to the GitHub Actions workspace

  ```yaml

  with:

    backend_config_file: prod.backend.tfvars

  ```

  - Type: string

  - Optional

## Environment Variables

* `GITHUB_DOT_COM_TOKEN`

  This is used to specify a token for GitHub.com when the action is running on a GitHub Enterprise instance.

  This is only used for downloading OpenTofu binaries from GitHub.com.

  If this is not set, an unauthenticated request will be made to GitHub.com to download the binary, which may be rate limited.

  - Type: string

  - Optional

* `TERRAFORM_CLOUD_TOKENS`

  For the purpose of detecting the Terraform version to use from a cloud backend.

  API tokens for cloud hosts, of the form `=`. Multiple tokens may be specified, one per line.

  These tokens may be used with the `remote` backend and for fetching required modules from the registry.

  e.g:

  ```yaml

  env:

    TERRAFORM_CLOUD_TOKENS: app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}

  ```

  With other registries:

  ```yaml

  env:

    TERRAFORM_CLOUD_TOKENS: |

      app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}

      terraform.example.com=${{ secrets.TF_REGISTRY_TOKEN }}

  ```

  - Type: string

  - Optional

## Example usage

This example automatically creates a pull request to fix any formatting

problems that get merged into the main branch.

```yaml

name: Fix Terraform file formatting

on:

  push:

    branches:

      - main

jobs:

  format:

    runs-on: ubuntu-latest

    name: Check Terraform file are formatted correctly

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: terraform fmt

        uses: dflook/terraform-fmt@v1

        with:

          path: my-terraform-config

      - name: Create Pull Request

        uses: peter-evans/create-pull-request@v5

        with:

          commit-message: terraform fmt

          title: Reformat terraform files

          body: Update Terraform files to canonical format using `terraform fmt`

          branch: automated-terraform-fmt

```