This action runs tflint with reviewdog on pull requests to enforce best practices.
By default, with reporter: github-pr-check
an annotation is added to
the line:
With reporter: github-pr-review
a comment is added to
the Pull Request Conversation:
Required. Must be in form of github_token: ${{ secrets.github_token }}
.
Optional. Report level for reviewdog [info
,warning
,error
].
It's same as -level
flag of reviewdog.
The default is error
.
Optional. Reporter of reviewdog command [github-pr-check
,github-pr-review
].
The default is github-pr-check
.
Optional. Directory to run the action on, from the repo root.
The default is .
( root of the repository).
Optional. List of arguments to send to tflint.
For the output to be parsable by reviewdog --format=checkstyle
is enforced.
The default is --module
.
The tflint
command return code.
The reviewdog
command return code.
name: reviewdog
on: [pull_request]
jobs:
tflint:
name: runner / tflint
runs-on: ubuntu-latest
steps:
- name: Clone repo
uses: actions/checkout@master
# Install latest Terraform manually as
# Docker-based GitHub Actions are
# slow due to lack of caching
# Note: Terraform is not neede for tflint
- name: Install Terraform
run: |
curl -LO https://raw.github.com/robertpeteuil/terraform-installer/master/terraform-install.sh
chmod +x terraform-install.sh
./terraform-install.sh -a
# Run init to get module code to be able to use `--deep`
- name: Terraform init
run: |
terraform init
- name: tflint
uses: reviewdog/action-tflint@master
with:
github_token: ${{ secrets.github_token }}
working_directory: "testdata" # Change working directory
reporter: github-pr-review # Change reporter
flags: "--deep" # Add custom flags
You can bump version on merging Pull Requests with specific labels (bump:major,bump:minor,bump:patch). Pushing tag manually by yourself also work.
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
This reviewdog action template itself is integrated with reviewdog to run lints which is useful for Docker container based actions.
Supported linters:
This repository uses haya14busa/action-depup to update reviewdog version.