https://github.com/tsubasaogawa/tfvdc-actions
A simple gh-actions to make sure that the variable contains a description
https://github.com/tsubasaogawa/tfvdc-actions
github-actions terraform
Last synced: 3 months ago
JSON representation
A simple gh-actions to make sure that the variable contains a description
- Host: GitHub
- URL: https://github.com/tsubasaogawa/tfvdc-actions
- Owner: tsubasaogawa
- License: mit
- Created: 2023-02-16T14:15:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-20T03:56:17.000Z (over 2 years ago)
- Last Synced: 2025-03-09T22:13:23.476Z (3 months ago)
- Topics: github-actions, terraform
- Homepage: https://github.com/marketplace/actions/tfvdc-actions
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tfvdc-actions
A simple gh-actions to make sure that the variable contains a description
## Features
- Warning if a variable block has not `description` field.
- Comment to pull request using [reviewdog](https://github.com/reviewdog/reviewdog).
## Usage
```yaml
- uses: tsubasaogawa/tfvdc-actions@v1
with:
input_path: ${{ github.workspace }}
result_path: ${{ github.workspace }}/tfvdc.out
- name: Run reviewdog
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
cd ${{ github.workspace }}
cat ${{ github.workspace }}/tfvdc.out | reviewdog -reporter=github-pr-review -f=golint
```
[Sample yaml file](https://github.com/tsubasaogawa/tfvdc-actions/blob/ae1a2233fc93ad821b0297db00e2fe2210ca04ed/.github/workflows/tfvdc.yml)
## Inputs
| Name | Description | Default |
| ----------- | ------------------------------------------------------- | ----------- |
| input_path | Input directory path contains Terraform variable blocks | . |
| result_path | Result file path | ~/tfvdc.out |
## Links
-