apply

Documentation

Overview

Package apply provides the Terraform apply functionality for Guardian.

Index

• Constants
• type ApplyRunCommand
  • func (c *ApplyRunCommand) Desc() string
  • func (c *ApplyRunCommand) Flags() *cli.FlagSet
  • func (c *ApplyRunCommand) Help() string
  • func (c *ApplyRunCommand) Process(ctx context.Context) (merr error)
  • func (c *ApplyRunCommand) Run(ctx context.Context, args []string) error
• type Config
  • func (c *Config) MapGitHubContext(context *githubactions.GitHubContext) error
• type RunResult

Constants

const (
	CommentPrefix = "**`🔱 Guardian 🔱 APPLY`** -"
)

Types

type ApplyRunCommand

type ApplyRunCommand struct {
	cli.BaseCommand

	flags.GitHubFlags
	flags.RetryFlags
	// contains filtered or unexported fields
}

ApplyRunCommand is a subcommand of apply and implements the cli.Command interface. It performs terraform apply on the given working directory.

func (*ApplyRunCommand) Desc

func (c *ApplyRunCommand) Desc() string

Desc provides a short, one-line description of the command.

func (*ApplyRunCommand) Flags

func (c *ApplyRunCommand) Flags() *cli.FlagSet

func (*ApplyRunCommand) Help

func (c *ApplyRunCommand) Help() string

Help is the long-form help output to include usage instructions and flag information.

func (*ApplyRunCommand) Process

func (c *ApplyRunCommand) Process(ctx context.Context) (merr error)

Process handles the main logic for the Guardian apply run process.

func (*ApplyRunCommand) Run

func (c *ApplyRunCommand) Run(ctx context.Context, args []string) error

type Config

type Config struct {
	// GitHub context values
	ServerURL  string // this value is used to generate URLs for creating links in pull request comments
	RunID      int64
	RunAttempt int64
}

Config defines the of configuration required for running the apply action.

func (*Config) MapGitHubContext

func (c *Config) MapGitHubContext(context *githubactions.GitHubContext) error

MapGitHubContext maps values from the GitHub context.

type RunResult

type RunResult struct {
	// contains filtered or unexported fields
}

RunResult is the result of a apply operation.