plan

Documentation

Overview

Package plan provide the Terraform planning functionality for Guardian.

Index

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

Constants

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

Types

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 plan action.

func (*Config) MapGitHubContext

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

MapGitHubContext maps values from the GitHub context.

type PlanCommand

type PlanCommand struct {
	actions.GitHubActionCommand

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

func (*PlanCommand) Desc

func (c *PlanCommand) Desc() string

func (*PlanCommand) Flags

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

func (*PlanCommand) Help

func (c *PlanCommand) Help() string

func (*PlanCommand) Process

func (c *PlanCommand) Process(ctx context.Context) error

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

func (*PlanCommand) Run

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

type RunResult

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

RunResult is the result of a plan operation.