actions/setup-terraform
1
0
Fork 0
mirror of https://github.com/hashicorp/setup-terraform.git synced 2025-12-16 08:32:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Updating README

Browse source
This commit is contained in:
Matthew Sanabria 2020-05-05 19:46:33 -04:00
parent 6a6b2bae2d
commit 0f3b6675b9
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -5,17 +5,19 @@
<a href="https://github.com/hashicorp/setup-terraform/actions"><img alt="Setup Terraform" src="https://github.com/hashicorp/setup-terraform/workflows/Setup%20Terraform/badge.svg" /></a> <a href="https://github.com/hashicorp/setup-terraform/actions"><img alt="Setup Terraform" src="https://github.com/hashicorp/setup-terraform/workflows/Setup%20Terraform/badge.svg" /></a>
</p> </p>
This action sets up Terraform CLI in your [GitHub Actions](https://github.com/features/actions) workflow by: The `hashicorp/setup-terraform` action is a JavaScript action that sets up Terraform CLI in your GitHub Actions workflow by:
- Downloading a specific version of Terraform CLI and adding it to the `PATH`. - Downloading a specific version of Terraform CLI and adding it to the `PATH`.
- Configuring the Terraform CLI configuration file with a Terraform Cloud/Enterprise hostname and API token. - Configuring the [Terraform CLI configuration file](/docs/commands/cli-config.html) with a Terraform Cloud/Enterprise hostname and API token.
- Optionally installing a wrapper to wrap subsequent calls of the `terraform` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. - Installing a wrapper script to wrap subsequent calls of the `terraform` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. (This can be optionally skipped if subsequent steps in the same job do not need to access the results of Terraform commands.)
After you've used the action, subsequent steps in the same job can run arbitrary Terraform commands using [the GitHub Actions `run` syntax](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun). This allows most Terraform commands to work exactly like they do on your local command line.
## Usage ## Usage
This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners. When running on `windows-latest` the shell should be set to Bash. This action can be run on `ubuntu-latest`, `windows-latest`, and `macos-latest` GitHub Actions runners. When running on `windows-latest` the shell should be set to Bash.
The default configuration installs the latest version of Terraform CLI and installs the wrapper to wrap subsequent calls to the `terraform` binary. The default configuration installs the latest version of Terraform CLI and installs the wrappers script to wrap subsequent calls to the `terraform` binary.
```yaml ```yaml
steps: steps:
@ -50,7 +52,7 @@ steps:
cli_config_credentials_token: ${{ secrets.TF_API_TOKEN }} cli_config_credentials_token: ${{ secrets.TF_API_TOKEN }}
``` ```
The wrapper installation can be skipped. The wrapper script installation can be skipped.
```yaml ```yaml
steps: steps:
@ -59,7 +61,7 @@ steps:
terraform_wrapper: false terraform_wrapper: false
``` ```
Subsequent steps can access outputs when the wrapper is installed. Subsequent steps can access outputs when the wrapper script is installed.
```yaml ```yaml
@ -76,7 +78,7 @@ steps:
- run: echo ${{ steps.plan.outputs.exitcode }} - run: echo ${{ steps.plan.outputs.exitcode }}
``` ```
The outputs can be used in subsequent steps to comment on the pull request: Outputs can be used in subsequent steps to comment on the pull request:
```yaml ```yaml
steps: steps: