outputs

Outputs action

A GitHub Action step that fetches outputs from an HCP Terraform workspace.

Documentation

---

Inputs

• token (Required): HCP Terraform API access token
• organization (Required): The organization
• workspace (Required): The name of the workspace
• hostname (Optional): The hostname (if not using HCP Terraform) of the Terraform Enterprise instance. Defaults to app.terraform.io

Outputs

• workspace-outputs-json: A JSON-stringified object containing the outputs fetched from the specified HCP Terraform workspace. Output names will match those found in your workspace. Sensitive output values will be redacted from runner logs.

Example Output Value

'{"example-list":["list", "of", "strings"],"aws_access_key_id":"ABCD1234","aws_secret_access_key":"ZYXW00+ABCD1234"}'

You will need to use fromJSON() to parse workspace-outputs-json in your workflow. Read more about fromJSON()

env:
  AWS_ACCESS_KEY_ID: ${{ fromJSON(steps.terraform-cloud-run.outputs.workspace-outputs).aws_access_key_id }}
  AWS_SECRET_ACCESS_KEY: ${{ fromJSON(steps.terraform-cloud-run.outputs.workspace-outputs).aws_secret_access_key }}

Workspace outputs that are marked as sensitive will be set as secret and redacted in the workflow.

Examples

name: Nightly Test
on:
  workflow_dispatch:
  schedule:
    - cron: 0 0 * * *

jobs:
  instance:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Fetch infra secrets
        id: fetch
        uses: hashicorp-forge/terraform-cloud-action/output@v1
        with:
          token: ${{ secrets.TFC_TOKEN }}
          organization: "example-org"
          workspace: "my-tflocal-workspace"

      - name: Tests
        run: go test ./...
        env:
          SOME_FOO: ${{ fromJSON(steps.fetch.outputs.workspace-outputs-json).foo }}
          SOME_BAR: ${{ fromJSON(steps.fetch.outputs.workspace-outputs-json).bar }}