Skip to main content

test-module

Source code

Format, lint, and validate Terraform Module and generate document of Terraform Module.

  • terraform fmt
  • terraform validate
  • tflint
  • tfsec
  • terraform-docs

Requirements

Dependent Actions

Example

- uses: suzuki-shunsuke/tfaction/test-module@main
with:
github_app_token: ${{ secrets.GITHUB_APP_TOKEN }}

Inputs

Required Inputs

namedescription
github_app_tokenGitHub Access Token. github.token can't be used because it can't invoke GitHub Actions Workflow

Optional Inputs

namedefaultdescription
github_tokengithub.tokenGitHub Access Token

Features

Generate Document

The command terraform-docs . > README.md is run in the module directory. If README.md is generated or updated in pull_request event, a commit is pushed to the feature branch $GITHUB_HEAD_REF.

image

--

image