Categorygithub.com/kvrhdn/go-tfe-run
modulepackage
0.3.3
Repository: https://github.com/kvrhdn/go-tfe-run.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
1
Files
307 SLOC

# README

go-tfe-run PkgGoDev

CI Integration Go Report Card codecov

A Go library to create and follow up on a run on Terraform Cloud. This library uses the Terraform Cloud API and does not rely on a local Terraform installation.

When would this be useful?

  • You want to configure parameters that are not available using the CLI, for example the name of the run.
  • You want to schedule a run but not wait for its completion.
  • You are in an environment without Terraform CLI installed.

If you wish to integrate this into your GitHub Actions workflows, checkout the tfe-run action which wraps go-tfe-run into a custom action.

Visit the documentation on pkg.go.dev.

License

This software is distributed under the terms of the MIT license, see LICENSE for details.

# Functions

NewClient creates a Client from ClientConfig.
String returns a pointer to the given string.

# Constants

Declaration of run types.
Declaration of run types.
Declaration of run types.

# Variables

ErrTimeout is returned when an operation timed out.

# Structs

Client is used to interact with the Run API of a single workspace on Terraform Cloud.
ClientConfig groups properties to configure a Client.
RunOptions groups all options available when creating a new run.
RunOutput holds the data that is generated by a run.

# Type aliases

RunType describes the type of run.