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"
Used to authenticate requests to the GitHub API to obtain release data from the TFLint repository. Authenticating will increase the API rate limit. Any valid token is supported. No permissions are required.
Default: ${{ github.token }}
If true, installs a wrapper script to wrap susbsequent calls of the tflint binary and expose its STDOUT, STDERR, and exit code as outputs.
Default: "false"
This action does not configure any outputs directly. However, when you set the tflint_wrapper input
to true, the following outputs are available for subsequent steps that call the tflint binary:
stdout- The STDOUT stream of the call to thetflintbinary.stderr- The STDERR stream of the call to thetflintbinary.exitcode- The exit code of the call to thetflintbinary.
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@v3
name: Checkout source code
- uses: actions/cache@v3
name: Cache plugin dir
with:
path: ~/.tflint.d/plugins
key: ${{ matrix.os }}-tflint-${{ hashFiles('.tflint.hcl') }}
- uses: terraform-linters/setup-tflint@v3
name: Setup TFLint
with:
tflint_version: v0.44.1
- name: Show version
run: tflint --version
- name: Init TFLint
run: tflint --init
env:
# https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/plugins.md#avoiding-rate-limiting
GITHUB_TOKEN: ${{ github.token }}
- name: Run TFLint
run: tflint -f compact- uses: terraform-linters/setup-tflint@v3or specify it explicitly as
- uses: terraform-linters/setup-tflint@v3
with:
tflint_version: latest- uses: terraform-linters/setup-tflint@v3
with:
github_token: ${{ secrets.MY_CUSTOM_GITHUB_TOKEN }}- uses: terraform-linters/setup-tflint@v3
- uses: terraform-linters/tflint-load-config-action@v1
with:
source-repo: me/tflint-config
- run: tflint -f compact- uses: terraform-linters/setup-tflint@v3
with:
tflint_wrapper: true
- id: tflint
run: tflint -f compact
- run: echo ${{ steps.tflint.outputs.stdout }}
- run: echo ${{ steps.tflint.outputs.stderr }}
- run: echo ${{ steps.tflint.outputs.exitcode }}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