Skip to content

Commit

Permalink
docs: update readme with terraform setup/known issue (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertKelly authored Jan 8, 2023
1 parent 0617c45 commit 7bd81c7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ with:
shared-infra-tfplan.json
```
## Terraform Configuration / Known Issues
#### Known issue when including the [Terraform Wrapper script](https://github.com/hashicorp/setup-terraform#inputs)
- Execution may error with `Error: Unexpected token c in JSON at position 1`
- **Cause**: Terraform wrapper enabled (default behavior) causes invalid JSON in Terraform output.
- **Fix**: Exclude the Terraform Wrapper when setting up Terraform (*GitHub Actions example*)
```yaml
- name: Setup Terraform
uses: hashicorp/setup-terraform@v2
with:
terraform_wrapper: false
```

## Contributing or Submitting Issues

### Contributions are welcome!
Expand Down

0 comments on commit 7bd81c7

Please sign in to comment.