An open API service indexing awesome lists of open source software.

https://github.com/terraform-linters/tflint-load-config-action

GitHub Action for loading TFLint configuration from a GitHub repository
https://github.com/terraform-linters/tflint-load-config-action

Last synced: 5 months ago
JSON representation

GitHub Action for loading TFLint configuration from a GitHub repository

Awesome Lists containing this project

README

          

# tflint Load Config Action

GitHub Action for copying a [TFLint](https://github.com/terraform-linters/tflint) configuration file from a remote repository.

## Usage

```yaml
name: TFLint
on: [push]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: terraform-linters/tflint-load-config-action@v1
with:
source-repo: me/tflint-config
- uses: terraform-linters/setup-tflint@v4
- run: tflint --format compact
```

### Action inputs

| Name | Description | Default |
| --- | --- | --- |
| `source-repo` | (Required) The repository from which the configuration will be copied. Format: `owner/name` ||
| `source-path` | Path to the configuration file in the remote repository | `.tflint.hcl` |
| `source-ref` | Ref or branch of the remote repository to target | |
| `destination-path` | Path where configuration file will be written locally | `$HOME/.tflint.hcl` |
| `token` | Github personal access token, [required](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#granting-additional-permissions) for reading from private repositories. ||

### Action outputs

The following outputs can be used by subsequent workflow steps.

| Name | Description |
| --- | --- |
| `path` | Path to the configuration file |

## Releasing

```sh
npm version (major|minor|patch) && git push --follow-tags
```