Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reviewdog/action-tflint
Run tflint with reviewdog on pull requests to enforce best practices
https://github.com/reviewdog/action-tflint
reviewdog tflint
Last synced: 1 day ago
JSON representation
Run tflint with reviewdog on pull requests to enforce best practices
- Host: GitHub
- URL: https://github.com/reviewdog/action-tflint
- Owner: reviewdog
- License: mit
- Created: 2019-09-26T16:19:46.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T14:22:55.000Z (7 months ago)
- Last Synced: 2024-04-09T03:41:38.763Z (7 months ago)
- Topics: reviewdog, tflint
- Language: Shell
- Size: 211 KB
- Stars: 98
- Watchers: 31
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-actions - Lint terraform files using tflint, with reviewdog output on the PR
- fucking-awesome-actions - Lint terraform files using tflint, with reviewdog output on the PR
- awesome-workflows - Lint terraform files using tflint, with reviewdog output on the PR
README
# GitHub Action: Run tflint with reviewdog
[](https://github.com/reviewdog/action-tflint/actions?query=workflow%3ATests)
[](https://github.com/reviewdog/action-tflint/actions?query=workflow%3ALint)
[](https://github.com/reviewdog/action-tflint/actions?query=workflow%3Arelease)
[](https://github.com/reviewdog/action-tflint/releases)
[](https://github.com/haya14busa/action-bumpr)
[](https://github.com/reviewdog/action-tflint/actions?query=workflow%3Adepup)
This action runs [tflint](https://github.com/wata727/tflint) with
[reviewdog](https://github.com/reviewdog/reviewdog) on pull requests
to enforce best practices.
## Examples
### With `github-pr-check`
By default, with `reporter: github-pr-check` an annotation is added to
the line:
### With `github-pr-review`
With `reporter: github-pr-review` a comment is added to
the Pull Request Conversation:
## Inputs
### `github_token`
**Required**. Must be in form of `github_token: ${{ secrets.github_token }}`.
### `level`
Optional. Report level for reviewdog [`info`,`warning`,`error`].
It's same as `-level` flag of reviewdog.
The default is `error`.
### `reporter`
Optional. Reporter of reviewdog command [`github-pr-check`,`github-pr-review`].
The default is `github-pr-check`.
### `filter_mode`
Optional. Filtering for the reviewdog command [`added`,`diff_context`,`file`,`nofilter`].
The default is `added`.
See [reviewdog documentation for filter mode](https://github.com/reviewdog/reviewdog/tree/master#filter-mode) for details.
### `fail_on_error`
Optional. Exit code for reviewdog when errors are found [`true`,`false`].
The default is `false`.
See [reviewdog documentation for exit codes](https://github.com/reviewdog/reviewdog/tree/master#exit-codes) for details.
### `working_directory`
Optional. Directory to run the action on, from the repo root.
The default is `.` ( root of the repository).
### `tflint_version`
Optional. The tflint version to install and use.
The default is `latest`.
### `tflint_rulesets`
Optional. Space separated, official (from the terraform-linters GitHub organization) tflint rulesets to install and use. If a pre-configured `TFLINT_PLUGIN_DIR` is set, rulesets are installed in that directory.
Default is `` (empty).
### `tflint_init`
Optional. Whether to run `tflint --init` prior to linting (useful if you have a .tflint.hcl with some values in it).
The default is `false`.
### `tflint_target_dir`
Optional. The target dir for the tflint command. This is the directory passed to tflint as opposed to working_directory which is the directory the command is executed from.
The default is `.`.
### `tflint_config`
Optional. Config file name for tflint.
The default is `.tflint.hcl`
### `flags`
Optional. List of arguments to send to `tflint`.
For the output to be parsable by reviewdog [`--format=checkstyle` is enforced](./entrypoint.sh).
The default is `--call-module-type=all`.
## Outputs
## `tflint-return-code`
The `tflint` command return code.
## `reviewdog-return-code`
The `reviewdog` command return code.
## Example usage
```yml
name: reviewdog
on: [pull_request]
jobs:
tflint:
name: runner / tflint
runs-on: ubuntu-latest
steps:
- name: Clone repo
uses: actions/checkout@v4
# Install latest Terraform manually as
# Docker-based GitHub Actions are
# slow due to lack of caching
# Note: Terraform is not needed for tflint
- name: Install Terraform
run: |
brew install terraform
# Run init to get module code to be able to use `--call-module-type=all`
- name: Terraform init
run: |
terraform init
# Minimal example
- name: tflint
uses: reviewdog/action-tflint@v1
with:
github_token: ${{ secrets.github_token }}
# More complex example
- name: tflint
uses: reviewdog/action-tflint@v1
with:
github_token: ${{ secrets.github_token }}
working_directory: "testdata" # Optional. Change working directory
reporter: github-pr-review # Optional. Change reporter
fail_on_error: "true" # Optional. Fail action if errors are found
filter_mode: "nofilter" # Optional. Check all files, not just the diff
tflint_version: "v0.24.0" # Optional. Custom version, instead of latest
tflint_rulesets: "azurerm google" # Optional. Extra official rulesets to install
flags: "--call-module-type=all" # Optional. Add custom tflint flags
```
## Development
### Release
#### [haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch).
Pushing tag manually by yourself also work.
#### [haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
ref: https://help.github.com/en/articles/about-actions#versioning-your-action
### Lint - reviewdog integration
This reviewdog action template itself is integrated with reviewdog to run lints
which is useful for Docker container based actions.
Supported linters:
- [reviewdog/action-shellcheck](https://github.com/reviewdog/action-shellcheck)
- [reviewdog/action-hadolint](https://github.com/reviewdog/action-hadolint)
- [reviewdog/action-misspell](https://github.com/reviewdog/action-misspell)