workflows

Documentation

Overview

Package workflows provides worklow helper functionality for Guardian.

Index

• type PlanStatusCommentCommand
  • func (c *PlanStatusCommentCommand) Desc() string
  • func (c *PlanStatusCommentCommand) Flags() *cli.FlagSet
  • func (c *PlanStatusCommentCommand) Help() string
  • func (c *PlanStatusCommentCommand) Process(ctx context.Context) error
  • func (c *PlanStatusCommentCommand) Run(ctx context.Context, args []string) error
• type PlanStatusCommentsConfig
  • func (c *PlanStatusCommentsConfig) MapGitHubContext(context *githubactions.GitHubContext) error
• type RemoveGuardianCommentsCommand
  • func (c *RemoveGuardianCommentsCommand) Desc() string
  • func (c *RemoveGuardianCommentsCommand) Flags() *cli.FlagSet
  • func (c *RemoveGuardianCommentsCommand) Help() string
  • func (c *RemoveGuardianCommentsCommand) Process(ctx context.Context) error
  • func (c *RemoveGuardianCommentsCommand) Run(ctx context.Context, args []string) error
• type ValidatePermissionsCommand
  • func (c *ValidatePermissionsCommand) Desc() string
  • func (c *ValidatePermissionsCommand) Flags() *cli.FlagSet
  • func (c *ValidatePermissionsCommand) Help() string
  • func (c *ValidatePermissionsCommand) Process(ctx context.Context) error
  • func (c *ValidatePermissionsCommand) Run(ctx context.Context, args []string) error
• type ValidatePermissionsConfig
  • func (c *ValidatePermissionsConfig) MapGitHubContext(context *githubactions.GitHubContext) error

Types

type PlanStatusCommentCommand

type PlanStatusCommentCommand struct {
	cli.BaseCommand

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

func (*PlanStatusCommentCommand) Desc

func (c *PlanStatusCommentCommand) Desc() string

func (*PlanStatusCommentCommand) Flags

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

func (*PlanStatusCommentCommand) Help

func (c *PlanStatusCommentCommand) Help() string

func (*PlanStatusCommentCommand) Process

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

Process handles the main logic for the Guardian remove plan comments process.

func (*PlanStatusCommentCommand) Run

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

type PlanStatusCommentsConfig

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

PlanStatusCommentsConfig defines the of configuration required for running the plan status comments command for GitHub workflows.

func (*PlanStatusCommentsConfig) MapGitHubContext

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

MapGitHubContext maps values from the GitHub context.

type RemoveGuardianCommentsCommand

type RemoveGuardianCommentsCommand struct {
	cli.BaseCommand

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

func (*RemoveGuardianCommentsCommand) Desc

func (c *RemoveGuardianCommentsCommand) Desc() string

func (*RemoveGuardianCommentsCommand) Flags

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

func (*RemoveGuardianCommentsCommand) Help

func (c *RemoveGuardianCommentsCommand) Help() string

func (*RemoveGuardianCommentsCommand) Process

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

Process handles the main logic for the Guardian remove plan comments process.

func (*RemoveGuardianCommentsCommand) Run

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

type ValidatePermissionsCommand

type ValidatePermissionsCommand struct {
	cli.BaseCommand

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

func (*ValidatePermissionsCommand) Desc

func (c *ValidatePermissionsCommand) Desc() string

func (*ValidatePermissionsCommand) Flags

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

func (*ValidatePermissionsCommand) Help

func (c *ValidatePermissionsCommand) Help() string

func (*ValidatePermissionsCommand) Process

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

Process handles the main logic for the Guardian validate permissions process.

func (*ValidatePermissionsCommand) Run

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

type ValidatePermissionsConfig

type ValidatePermissionsConfig struct {
	// GitHub context values
	Actor string
}

ValidatePermissionsConfig defines the of configuration required for running the validate permissions command for GitHub workflows.

func (*ValidatePermissionsConfig) MapGitHubContext

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

MapGitHubContext maps values from the GitHub context.