linter

Documentation

Index

• type Linter
  • func New(opts ...Option) *Linter
  • func (l *Linter) Lint(configs []*WorkflowConfig) error
• type Option
  • func PrivilegedPlugins(plugins []string) Option
  • func WithTrusted(trusted TrustedConfiguration) Option
  • func WithTrustedClonePlugins(plugins []string) Option
• type TrustedConfiguration
• type WorkflowConfig

Types

type Linter

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

A Linter lints a pipeline configuration.

func New

func New(opts ...Option) *Linter

New creates a new Linter with options.

func (*Linter) Lint

func (l *Linter) Lint(configs []*WorkflowConfig) error

Lint lints the configuration.

type Option

type Option func(*Linter)

Option configures a linting option.

func PrivilegedPlugins

func PrivilegedPlugins(plugins []string) Option

PrivilegedPlugins adds the list of privileged plugins.

func WithTrusted

func WithTrusted(trusted TrustedConfiguration) Option

WithTrusted adds the trusted option to the linter.

func WithTrustedClonePlugins

func WithTrustedClonePlugins(plugins []string) Option

WithTrustedClonePlugins adds the list of trusted clone plugins.

type TrustedConfiguration

type TrustedConfiguration struct {
	Network  bool
	Volumes  bool
	Security bool
}

type WorkflowConfig

type WorkflowConfig struct {
	// File is the path to the configuration file.
	File string

	// RawConfig is the raw configuration.
	RawConfig string

	// Config is the parsed configuration.
	Workflow *types.Workflow
}