{"id":21261400,"url":"https://github.com/dflook/terraform-output","last_synced_at":"2025-07-11T03:31:29.278Z","repository":{"id":61301421,"uuid":"277396449","full_name":"dflook/terraform-output","owner":"dflook","description":"GitHub action to get outputs from a terraform configuration","archived":false,"fork":false,"pushed_at":"2025-05-29T10:39:51.000Z","size":55,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-29T12:29:55.397Z","etag":null,"topics":["actions","devops","github-action","github-actions","terraform"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dflook.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["dflook"]}},"created_at":"2020-07-05T22:53:25.000Z","updated_at":"2025-05-29T10:39:52.000Z","dependencies_parsed_at":"2023-02-18T01:31:23.942Z","dependency_job_id":"0c5204e8-55ee-48ae-beab-67e780a0ff56","html_url":"https://github.com/dflook/terraform-output","commit_stats":{"total_commits":57,"total_committers":1,"mean_commits":57.0,"dds":0.0,"last_synced_commit":"6d324191df65d239cfb7844b9779140bd851c012"},"previous_names":[],"tags_count":307,"template":false,"template_full_name":null,"purl":"pkg:github/dflook/terraform-output","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-output","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-output/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-output/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-output/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dflook","download_url":"https://codeload.github.com/dflook/terraform-output/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dflook%2Fterraform-output/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264721304,"owners_count":23653917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","devops","github-action","github-actions","terraform"],"created_at":"2024-11-21T04:29:26.090Z","updated_at":"2025-07-11T03:31:29.272Z","avatar_url":"https://github.com/dflook.png","language":null,"funding_links":["https://github.com/sponsors/dflook"],"categories":[],"sub_categories":[],"readme":"# terraform-output action\n\nThis is one of a suite of Terraform related actions - find them at [dflook/terraform-github-actions](https://github.com/dflook/terraform-github-actions).\n\nRetrieve the root-level outputs from a Terraform configuration.\n\n## Inputs\n\n* `path`\n\n  The path to the Terraform root module directory.\n\n  - Type: string\n  - Optional\n  - Default: The action workspace\n\n* `workspace`\n\n  Terraform workspace to get outputs from\n\n  - Type: string\n  - Optional\n  - Default: `default`\n\n* `backend_config`\n\n  List of Terraform backend config values, one per line.\n\n  ```yaml\n  with:\n    backend_config: token=${{ secrets.BACKEND_TOKEN }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `backend_config_file`\n\n  List of Terraform backend config files to use, one per line.\n  Paths should be relative to the GitHub Actions workspace\n\n  ```yaml\n  with:\n    backend_config_file: prod.backend.tfvars\n  ```\n\n  - Type: string\n  - Optional\n\n## Outputs\n\n* Terraform Outputs\n\n  An action output will be created for each output of the Terraform configuration.\n\n  For example, with the Terraform config:\n\n  ```hcl\n  output \"service_hostname\" {\n    value = \"example.com\"\n  }\n  ```\n\n  Running this action will produce a `service_hostname` output with the value `example.com`.\n\n  ### Primitive types (string, number, bool)\n\n  The values for these types get cast to a string with boolean values being 'true' and 'false'.\n\n  ### Complex types (list/set/tuple \u0026 map/object)\n\n  The values for complex types are output as a JSON string. Terraform `list`, `set` \u0026 `tuple` types are cast to a JSON array, `map` and `object` types are cast to a JSON object.\n\n  These values can be used in a workflow expression by using the [fromJSON](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#fromjson) function\n\n## Environment Variables\n\n* `GITHUB_DOT_COM_TOKEN`\n\n  This is used to specify a token for GitHub.com when the action is running on a GitHub Enterprise instance.\n  This is only used for downloading OpenTofu binaries from GitHub.com.\n  If this is not set, an unauthenticated request will be made to GitHub.com to download the binary, which may be rate limited.\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_CLOUD_TOKENS`\n\n  API tokens for cloud hosts, of the form `\u003chost\u003e=\u003ctoken\u003e`. Multiple tokens may be specified, one per line.\n  These tokens may be used with the `remote` backend and for fetching required modules from the registry.\n\n  e.g:\n\n  ```yaml\n  env:\n    TERRAFORM_CLOUD_TOKENS: app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}\n  ```\n\n  With other registries:\n\n  ```yaml\n  env:\n    TERRAFORM_CLOUD_TOKENS: |\n      app.terraform.io=${{ secrets.TF_CLOUD_TOKEN }}\n      terraform.example.com=${{ secrets.TF_REGISTRY_TOKEN }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_SSH_KEY`\n\n  A SSH private key that Terraform will use to fetch git/mercurial module sources.\n\n  This should be in PEM format.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_SSH_KEY: ${{ secrets.TERRAFORM_SSH_KEY }}\n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_HTTP_CREDENTIALS`\n\n  Credentials that will be used for fetching modules sources with `git::http://`, `git::https://`, `http://` \u0026 `https://` schemes.\n\n  Credentials have the format `\u003chost\u003e=\u003cusername\u003e:\u003cpassword\u003e`. Multiple credentials may be specified, one per line.\n\n  Each credential is evaluated in order, and the first matching credentials are used.\n\n  Credentials that are used by git (`git::http://`, `git::https://`) allow a path after the hostname.\n  Paths are ignored by `http://` \u0026 `https://` schemes.\n  For git module sources, a credential matches if each mentioned path segment is an exact match.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_HTTP_CREDENTIALS: |\n      example.com=dflook:${{ secrets.HTTPS_PASSWORD }}\n      github.com/dflook/terraform-github-actions.git=dflook-actions:${{ secrets.ACTIONS_PAT }}\n      github.com/dflook=dflook:${{ secrets.DFLOOK_PAT }}\n      github.com=graham:${{ secrets.GITHUB_PAT }}  \n  ```\n\n  - Type: string\n  - Optional\n\n* `TERRAFORM_PRE_RUN`\n\n  A set of commands that will be ran prior to `terraform init`. This can be used to customise the environment before running Terraform.\n\n  The runtime environment for these actions is subject to change in minor version releases. If using this environment variable, specify the minor version of the action to use.\n\n  The runtime image is currently based on `debian:bookworm`, with the command run using `bash -xeo pipefail`.\n\n  For example:\n\n  ```yaml\n  env:\n    TERRAFORM_PRE_RUN: |\n      # Install latest Azure CLI\n      curl -skL https://aka.ms/InstallAzureCLIDeb | bash\n\n      # Install postgres client\n      apt-get install -y --no-install-recommends postgresql-client\n  ```\n\n  - Type: string\n  - Optional\n\n## Example usage\n\n### String\n\nThis example uses a Terraform string output to get a hostname:\n\n```yaml\non: [push]\n\njobs:\n  show_hostname:\n    runs-on: ubuntu-latest\n    name: Show the hostname\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Get outputs\n        uses: dflook/terraform-output@v2\n        id: tf-outputs\n        with:\n          path: my-terraform-config\n\n      - name: Print the hostname\n        run: echo \"The hostname is ${{ steps.tf-outputs.outputs.hostname }}\"\n```\n\n### Complex output\n\nThis example gets information from object and array(object) outputs.\n\nWith this Terraform config:\n\n```hcl\noutput \"vpc\" {\n  value = aws_vpc.test\n}\noutput \"subnets\" {\n  value = [aws_subnet.a, aws_subnet.b, aws_subnet.c]\n}\n```\n\nWe can use the workflow:\n\n```yaml\njobs:\n  output_example:\n    runs-on: ubuntu-latest\n    name: An example of workflow expressions with terraform output\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Get outputs\n        uses: dflook/terraform-output@v2\n        id: tf-outputs\n        with:\n          path: my-terraform-config\n\n      - name: Print VPC\n        run: |\n          echo \"The vpc-id is ${{ fromJson(steps.tf-outputs.outputs.vpc).id }}\"\n          echo \"The subnet-ids are ${{ join(fromJson(steps.tf-outputs.outputs.subnets).*.id) }}\"          \n```\n\nWhich will print to the workflow log:\n\n```text\nThe vpc-id is vpc-01463b6b84e1454ce\nThe subnet-ids are subnet-053008016a2c1768c,subnet-07d4ce437c43eba2f,subnet-0a5f8c3a20023b8c0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdflook%2Fterraform-output","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdflook%2Fterraform-output","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdflook%2Fterraform-output/lists"}