Awesome

github-action-tflint

GitHub Actions for tflint.

Run tflint and notify the result with reviewdog and github-comment. This GitHub Actions does not install tflint and reviewdog, so you have to install them in advance. It allows to install tools outside this action. We recommend aqua to install them.

Motivation

We know there are other GitHub Actions for tflint. They install tflint automatically, but we would like to manage tools with aqua, which is a declarative CLI Version Manager written in Go. By aqua, you can update tools continuously with Renovate very easily and use the same tool versions in both CI and your development environment. This GitHub Actions does not install tflint, so we can install them outside this action.

Requirements

tflint
reviewdog
(Optional) github-comment
(Optional) ghcp: If the input fix is true, ghcp is required.

You can install these tools by aqua:

aqua g -i terraform-linters/tflint reviewdog/reviewdog suzuki-shunsuke/github-comment int128/ghcp

Notification with reviewdog

Notification with github-comment

- uses: suzuki-shunsuke/github-action-tflint@main
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    working_directory: tests
    github_comment: true # Enable github-comment notification

:bulb: If you want to hide old notification, please use github-comment hide command.

Example

- uses: suzuki-shunsuke/github-action-tflint@v0.1.1

- uses: suzuki-shunsuke/github-action-tflint@v0.1.1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    github_token_for_tflint_init: ${{ secrets.GH_TOKEN_FOR_TFLINT_INIT }}
    github_token_for_fix: ${{ secrets.GH_TOKEN_FOR_FIX }}
    working_directory: foo
    github_comment: "true"
    fix: "true"

Inputs

Required Inputs

Nothing.

Optional Inputs

name	default value	description
github_token	`github.token`	GitHub Access Token. The permission `pull-requests:write` is required.
github_token_for_tflint_init	`github_token`	GitHub Access Token for `tflint --init`. It this isn't set, the input `github_token` is used. This input is useful for a GitHub Enterprise Server. The permission `contents:read` is required
github_token_for_fix	`github_token`	GitHub Access Token for `tflint --fix`. It this isn't set, the input `github_token` is used. The permission `contents:write` is required.
working_directory	"" (current directory)	Woring Directory
github_comment	`false`	Whether a comment is posted with github-comment
fix	false	If this is true, code is fixed by `tflint --fix`. ghcp is required for this

Outputs

Nothing.

License

MIT