Terramate Github Action

The terramate-io/terramate-action is a GitHub composite action that sets up Terramate CLI in your GitHub Actions workflows.

• It downloads a specific version or falls back to an asdf configured version or the latest available release of Terramate CLI.
• It installs Terramate CLI into a user specified path or by default to /usr/local/bin
• It installs a wrapper script by default so that calls to terramate binary will expose GitHub Action outputs to access the stderr, stderr, and the exitcode of the terramate execution.
• It allows you to configure a default Terramate Cloud organization to use Terramate Cloud Features like Drift Detection and Stack Health Information.

Compatbility

The action currently only supports ubuntu runners. Please open an issue, if more runner support is required.

Usage

The default action installs Terramate CLI in it's latest version unless a specific version is configured by asdf config file .tool-versions.

steps:
  - uses: terramate-io/terramate-action@v1

You can disable asdf integration by explicitly specifying "latest" as the desired version.

steps:
  - uses: terramate-io/terramate-action@v1
    with:
      version: "latest"

To install a specific version the version can be specified using the version argument:

steps:
  - uses: terramate-io/terramate-action@v1
    with:
      version: "0.4.2"

The binary will be installed to /usr/local/bin by default. This location can be changed using the bindir argument:

steps:
  - uses: terramate-io/terramate-action@v1
    with:
      bindir: /usr/local/bin

To configure the default Terramate Cloud Organization set cloud_organization argument to your organization short name:

steps:
  - uses: terramate-io/terramate-action@v1
    with:
      cloud_organization: myorganization

To disable using the optional wrapper script by default the use_wrapper argument can be set to "false":

steps:
  - uses: terramate-io/terramate-action@v1
    with:
      use_wrapper: "false"

Subsequent steps can access outputs when the wrapper script is installed:

steps:
  - uses: terramate-io/terramate-action@v1

  - id: list
    run: terramate list --changed

  - run: echo ${{ steps.list.outputs.stdout }}
  - run: echo ${{ steps.list.outputs.stderr }}
  - run: echo ${{ steps.list.outputs.exitcode }}

License

See the LICENSE file for licensing information.

Terramate

Terramate is a CNCF and Linux Foundation silver member.