Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.84 KB

README.md

File metadata and controls

47 lines (37 loc) · 1.84 KB

Apply action

A GitHub Action that creates an apply (or destroy) run in an HCP Terraform workspace. Use this in conjunction with the outputs action to assemble GitHub Action pipelines using infrastructure managed by HCP Terraform.

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
  • wait (Optional): If set, waits for the run to terminate and resources to be processed before the action finishes. Defaults to true.
  • auto-apply (Optional): If set, applies changes when a Terraform plan is successful. Defaults to true.
  • is-destroy (Optional): If set, a destroy plan will be run. Defaults to false.
  • message (Optional): A custom message to associate with the run. Default to "Run created by GitHub action"
  • replace-addrs (Optional): Multi-line list of resource addresses to be replaced. Use one address per line.
  • target-addrs (Optional): Multi-line list of resource addresses that Terraform should focus its planning efforts on. Use one address per line.

Read more about the Runs API

Outputs

  • run-id: The run ID for the created run.

Example Usage

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

jobs:
  infra:
    runs-on: ubuntu-latest
    steps:
      - name: Create infra
        id: infra
        uses: hashicorp-forge/terraform-cloud-action/apply@v1
        with:
          token: ${{ secrets.TFC_TOKEN }}
          organization: example-org
          workspace: my-workspace
          wait: true