shell

Documentation

Overview

Package shell provides functions to run shell commands and Terraform commands.

Index

• Constants
• func ExplainError(err error) string
• func GitLastReleaseTag(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) (string, error)
• func GitRepoTags(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) ([]string, error)
• func GitTopLevelDir(ctx context.Context, terragruntOptions *options.TerragruntOptions, path string) (string, error)
• func LastReleaseTag(tags []string) string
• func PromptUserForInput(ctx context.Context, prompt string, ...) (string, error)
• func PromptUserForYesNo(ctx context.Context, prompt string, ...) (bool, error)
• func RunCommand(ctx context.Context, opts *options.TerragruntOptions, command string, ...) error
• func RunCommandWithOutput(ctx context.Context, opts *options.TerragruntOptions, workingDir string, ...) (*util.CmdOutput, error)

Constants

const SignalForwardingDelay = time.Second * 15

SignalForwardingDelay is the time to wait before forwarding the signal to the subcommand.

The signal can be sent to the main process (only `terragrunt`) as well as the process group (`terragrunt` and `terraform`), for example: kill -INT <pid> # sends SIGINT only to the main process kill -INT -<pid> # sends SIGINT to the process group Since we cannot know how the signal is sent, we should give `tofu`/`terraform` time to gracefully exit if it receives the signal directly from the shell, to avoid sending the second interrupt signal to `tofu`/`terraform`.

Functions

func ExplainError

func ExplainError(err error) string

ExplainError will try to explain the error to the user, if we know how to do so.

func GitLastReleaseTag

func GitLastReleaseTag(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) (string, error)

GitLastReleaseTag fetches git repository last release tag.

func GitRepoTags

func GitRepoTags(ctx context.Context, opts *options.TerragruntOptions, gitRepo *url.URL) ([]string, error)

GitRepoTags fetches git repository tags from passed url.

func GitTopLevelDir

func GitTopLevelDir(ctx context.Context, terragruntOptions *options.TerragruntOptions, path string) (string, error)

GitTopLevelDir fetches git repository path from passed directory.

func LastReleaseTag

func LastReleaseTag(tags []string) string

LastReleaseTag returns last release tag from passed tags slice.

func PromptUserForInput

func PromptUserForInput(ctx context.Context, prompt string, terragruntOptions *options.TerragruntOptions) (string, error)

PromptUserForInput prompts the user for text in the CLI. Returns the text entered by the user.

func PromptUserForYesNo

func PromptUserForYesNo(ctx context.Context, prompt string, terragruntOptions *options.TerragruntOptions) (bool, error)

PromptUserForYesNo prompts the user for a yes/no response and return true if they entered yes.

func RunCommand

func RunCommand(ctx context.Context, opts *options.TerragruntOptions, command string, args ...string) error

RunCommand runs the given shell command.

func RunCommandWithOutput

func RunCommandWithOutput(
	ctx context.Context,
	opts *options.TerragruntOptions,
	workingDir string,
	suppressStdout bool,
	needsPTY bool,
	command string,
	args ...string,
) (*util.CmdOutput, error)

RunCommandWithOutput runs the specified shell command with the specified arguments.

Connect the command's stdin, stdout, and stderr to the currently running app. The command can be executed in a custom working directory by using the parameter `workingDir`. Terragrunt working directory will be assumed if empty string.