A GitHub action that installs a Terraform linter TFLint executable in the PATH.

Required The version of TFLint which will be installed. See TFLint releases page for valid versions.

If version is "latest", the action will get the latest version number using Octokit.

Default: "latest"

If set, github_token will be used for Octokit authentication. Authenticating will increase the API rate limit when querying the tflint repository to get the latest release version.

The action does not have any output.

name: Lint
on:
  push:
    branches: [ master ]
  pull_request:

jobs:
  tflint:
    runs-on: ${{ matrix.os }}

    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]

    steps:
    - uses: actions/checkout@v1
      name: Checkout source code

    - uses: terraform-linters/setup-tflint@v1
      name: Setup TFLint
      with:
        tflint_version: v0.26.0

    - name: Show version
      run: tflint --version

    - name: Run TFLint
      run: tflint -f compact

For latest release you can omit version variable and use

- uses: terraform-linters/setup-tflint@v1

or specify it explicitly as

- uses: terraform-linters/setup-tflint@v1
  with:
    tflint_version: latest

For authenticating with the GITHUB_TOKEN you can use

- uses: terraform-linters/setup-tflint@v1
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}

This action supports Problem Matchers for --format compact. You can see annotations in pull requests when TFLint prints issues with the compact format.

To create a new version:

npm version $inc && git push --follow-tags