https://github.com/terraform-linters/setup-tflint
A GitHub action that installs Terraform linter TFLint
https://github.com/terraform-linters/setup-tflint
Last synced: 8 months ago
JSON representation
A GitHub action that installs Terraform linter TFLint
- Host: GitHub
- URL: https://github.com/terraform-linters/setup-tflint
- Owner: terraform-linters
- License: mit
- Created: 2020-07-22T14:52:10.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T00:46:41.000Z (over 1 year ago)
- Last Synced: 2024-05-17T12:46:41.886Z (over 1 year ago)
- Language: JavaScript
- Size: 2.22 MB
- Stars: 129
- Watchers: 8
- Forks: 33
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Setup TFLint Action
A GitHub action that installs a Terraform linter [TFLint](https://github.com/terraform-linters/tflint) executable in the PATH.
## Inputs
All inputs are optional, but may include a default where specified.
### `tflint_version`
The version of TFLint which will be installed. See [TFLint releases page](https://github.com/terraform-linters/tflint/releases) for valid versions.
If version is `"latest"`, the action will get the latest version number using [Octokit](https://octokit.github.io/rest.js/).
Default: `"latest"`
### `checksums`
A newline-delimited list of valid checksums (SHA256 hashes) for the downloaded TFLint binary. When set, the action will verify that the binary matches one of these checksums before proceeding.
This ensures that the downloaded binary for a given version is a known build. If your job runs in multiple operating systems or architectures, include appropriate checksums for all of them.
**Note:** Checksums ensure _immutability_, but do not verify integrity. To prove that checksums come from a known build in TFLint's official repository, use [GitHub’s Artifact Attestations](https://github.com/terraform-linters/tflint?tab=readme-ov-file#github-cli-recommended) or [cosign](https://github.com/terraform-linters/tflint?tab=readme-ov-file#cosign).
### `github_token`
Used to authenticate requests to the GitHub API to obtain release data from the TFLint repository. Authenticating will increase the [API rate limit](https://developer.github.com/v3/#rate-limiting). Any valid token is supported. No permissions are required.
Default: `${{ github.server_url == 'https://github.com' && github.token || '' }}`
GitHub Enterprise Server will make requests to github.com anonymously by default. To authenticate these requests, you must issue a token from github.com and pass it explicitly.
### `tflint_wrapper`
Installs a wrapper script to wrap subsequent calls to `tflint` and expose `stdout`, `stderr`, and `exitcode` outputs.
Default: `"false"`
## Outputs
The following outputs are available when the `tflint_wrapper` input is enabled:
- `stdout` - The output (stdout) produced by the tflint command.
- `stderr` - The error output (stderr) produced by the tflint command.
- `exitcode` - The exit code produced by the tflint command.
## Usage
```yaml
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@v4
name: Checkout source code
- uses: actions/cache@v4
name: Cache plugin dir
with:
path: ~/.tflint.d/plugins
key: ${{ matrix.os }}-tflint-${{ hashFiles('.tflint.hcl') }}
- uses: terraform-linters/setup-tflint@v4
name: Setup TFLint
with:
tflint_version: v0.52.0
- 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
```
### Latest Release
```yaml
- uses: terraform-linters/setup-tflint@v4
```
or specify it explicitly as
```yaml
- uses: terraform-linters/setup-tflint@v4
with:
tflint_version: latest
```
### Using Custom GitHub Token
```yaml
- uses: terraform-linters/setup-tflint@v4
with:
github_token: ${{ secrets.MY_CUSTOM_GITHUB_TOKEN }}
```
### Loading Shared Configuration
```yaml
- uses: terraform-linters/setup-tflint@v4
- uses: terraform-linters/tflint-load-config-action@v1
with:
source-repo: me/tflint-config
- run: tflint -f compact
```
### Wrapper
```yaml
- uses: terraform-linters/setup-tflint@v4
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 }}
```
### Checks
This action supports [Problem Matchers](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md) for `--format compact`. You can see annotations in pull requests when TFLint prints issues with the `compact` format.
## Releasing
To create a new version:
```sh
npm version $inc && git push --follow-tags
```