devops-infra / action-format-hcl

GitHub Action automatically formatting all HCL and TF files

GitHub Action for formating HCL files

GitHub Action automatically formatting all HCL and TF files (.hcl, .tf, .tfvars).

Dockerized as devopsinfra/action-format-hcl.

Features:

• Container is a stripped down image of my other creation - devopsinfra/docker-terragrunt - framework for managing Infrastructure-as-a-Code.
• Main use will be everywhere where Terraform or Terragrunt is used.
• Using combination of my wrapper for cytopia's docker-terragrunt-fmt.

Badge swag

Reference

    - name: Fail on malformatted files
      uses: devops-infra/[email protected]
      with:
        list: false
        write: true
        ignore: "config"
        diff: false
        check: false
        recursive: true
        dir: "modules"

Input Variable	Required	Default	Description
list	No	false	List files containing formatting inconsistencies.
write	No	true	Overwrite input files. Disabled if using check.
ignore	No	""	Comma separated list of paths to ignore. Only for .hcl files.
diff	No	false	Display diffs of formatting changes.
check	No	false	Check if files are malformatted.
recursive	No	true	Also process files in subdirectories.
dir	No	""	Path to be checked. Current dir as default.

Examples

Action can fail if malformed files will be found.

name: Check HCL
on:
  push
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2
    - name: Fail on malformatted files
      uses: devops-infra/[email protected]
      with:
        check: true

Action can automatically format all HCL files and commit updated files back to the repository using my other action action-commit-push.

name: Format HCL
on:
  push
jobs:
  format-hcl:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2
    - name: Format HCL files
      uses: devops-infra/[email protected]
    - name: Commit changes to repo
      uses: devops-infra/action-commit-push@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        commit_prefix: "[AUTO-FORMAT-HCL]"

action-format-hcl's Issues

git not handling unchanged files properly

I tested the Github action against HachiCorp Vault policy files, since it detects the formatting errors in the policies, then it failed because doesn't find tf and tfvars.

=> Searching for .tf and .tfvars files
error: unknown option `staged'

Wanted to see if you can include HCL Vault policies in the action or see if I can omit the step about searching .tf and .tfvars files in order to work with Vault.

git diff: unknow option 'staged'

Brief description

I tried to integration action-format-hcl within my CI phase.

Here is he workflow I've used : https://github.com/Xat59/githubactionstest/blob/main/.github/workflows/main.yml
And here is the output where you can see the error : https://github.com/Xat59/githubactionstest/pull/1/checks?check_run_id=1420263439

As you can see, I get the unknow option 'staged' when the workflow runs git diff.

Maybe the ubuntu:latest runner does contain a git version that allows --staged option on git diff command ?
I also tried ubuntu-16.04 and ubuntu-20.04 for the runner, instead of ubuntu-latest, but I get the same result.

Thanks

`check: true` requires `write: false`

📝 Brief description

The docs for write say "Disabled if using check", but if you pass check: true without write: false you will end up with something like this:

Inputs:
  list: false
  write: true
  ignore: 
  diff: true
  check: true
  recursive: true
  dir: 

=> Searching for .hcl files
Error, -check and -write=true cannot be used together

because the default write:true gets passed down to the script.

I would expect based on the README that it would be fine to specify check: true without mentioning write.

Error trying to lint one hcl file

Hi there,

I am getting an error once I try to lint only one .hcl file. According to the error looks like the recursive flag is enabled once a single file is passed in the dir parameter. Can you add support to lint only one .hcl file?

Thanks,

check input error.

I've set up the linter with the following settings:

- name: Fail on malformatted files
        uses: devops-infra/[email protected]
        with:
          check: true
          write: false

I am getting the error attached in the screenshot.
Despite I set up 'write:false'. Looks like it's ignoring it, then I get the error:

=> Searching for .hcl files
Error, -check and -write=true cannot be used together