plugin

Documentation

Index

• Constants
• Variables
• func Flags() []cli.Flag
• func SetupConsoleLogger(ctx context.Context, cmd *cli.Command) (context.Context, error)
• type Author
• type Commit
• type Environment
  • func EnvironmentFromContext(cmd *cli.Command) (Environment, error)
  • func (e Environment) Lookup(key string) (string, bool)
  • func (e Environment) Value() []string
• type ExecuteFunc
• type Metadata
  • func MetadataFromContext(cmd *cli.Command) Metadata
• type Network
  • func NetworkFromContext(cmd *cli.Command) Network
• type Options
• type Pipeline
• type Plugin
  • func New(opt Options) *Plugin
  • func (p *Plugin) Run()
• type Repository
• type Step
• type System

Constants

const (
	FlagsRepositoryCategory = "Woodpecker Repository Flags"
	FlagsPipelineCategory   = "Woodpecker Pipeline Flags"
	FlagsCommitCategory     = "Woodpecker Commit Flags"
	FlagsStepCategory       = "Woodpecker Step Flags"
	FlagsSystemCategory     = "Woodpecker System Flags"
	FlagsPluginCategory     = "Plugin Flags"
)

const (
	NetDailerTimeout                 = 30 * time.Second
	HTTPTransportIdleTimeout         = 90 * time.Second
	HTTPTransportTLSHandshakeTimeout = 10 * time.Second
	HTTPTransportMaxIdleConns        = 100
)

Variables

var ErrTypeAssertionFailed = errors.New("type assertion failed")

Functions

func Flags

func Flags() []cli.Flag

Flags has the cli.Flags for the Woodpecker plugin.

func SetupConsoleLogger

func SetupConsoleLogger(ctx context.Context, cmd *cli.Command) (context.Context, error)

SetupConsoleLogger sets up the console logger.

Types

type Author

type Author struct {
	Name   string
	Email  string
	Avatar string
}

Author defines runtime metadata for a commit author.

type Commit

type Commit struct {
	URL          string
	SHA          string
	Ref          string
	Refspec      string
	PullRequest  int64
	SourceBranch string
	TargetBranch string
	Branch       string
	Tag          string
	Message      string
	Title        string
	Description  string
	Author       Author
}

Commit defines runtime metadata for a commit.

type Environment

type Environment map[string]string

func EnvironmentFromContext

func EnvironmentFromContext(cmd *cli.Command) (Environment, error)

func (Environment) Lookup

func (e Environment) Lookup(key string) (string, bool)

Lookup retrieves the value for the given key from the Environment. If the key is not found in the Environment, it falls back to looking up the value in the OS environment.

func (Environment) Value

func (e Environment) Value() []string

Value returns a slice of strings representing the key-value pairs of the Environment. Each string is formatted as "key=value".

type ExecuteFunc

type ExecuteFunc func(ctx context.Context) error

ExecuteFunc defines the function that is executed by the plugin.

type Metadata

type Metadata struct {
	Repository Repository
	Pipeline   Pipeline
	Curr       Commit
	Prev       Commit
	Step       Step
	System     System
}

Metadata defines runtime metadata.

func MetadataFromContext

func MetadataFromContext(cmd *cli.Command) Metadata

MetadataFromContext creates a Metadata from the cli.Command.

type Network

type Network struct {
	// Context for making network requests.
	//
	// If `trace` logging is requested the context will use `httptrace` to
	// capture all network requests.
	//nolint:containedctx
	Context context.Context

	/// Whether SSL verification is skipped or not.
	InsecureSkipVerify bool

	// Client for making network requests.
	Client *http.Client
}

Network contains options for connecting to the network.

func NetworkFromContext

func NetworkFromContext(cmd *cli.Command) Network

type Options

type Options struct {
	// Name of the plugin.
	Name string
	// Description of the plugin.
	Description string
	// Version of the plugin.
	Version string
	// Version metadata of the plugin.
	VersionMetadata string
	// Flags of the plugin.
	Flags []cli.Flag
	// Execute function of the plugin.
	Execute ExecuteFunc
	// Hide woodpecker system flags.
	HideWoodpeckerFlags bool
}

Options defines the options for the plugin.

type Pipeline

type Pipeline struct {
	Number       int64
	Status       string
	Event        string
	URL          string
	DeployTarget string
	Created      time.Time
	Started      time.Time
	Finished     time.Time
	Parent       int64
}

Pipeline defines runtime metadata for a pipeline.

type Plugin

type Plugin struct {
	App *cli.Command

	// Network options.
	Network Network
	// Metadata of the current pipeline.
	Metadata    Metadata
	Environment Environment
	// contains filtered or unexported fields
}

Plugin defines the plugin instance.

func New

func New(opt Options) *Plugin

New plugin instance.

func (*Plugin) Run

func (p *Plugin) Run()

Run the plugin.

type Repository

type Repository struct {
	Slug     string
	Name     string
	Owner    string
	URL      string
	CloneURL string
	Private  bool
	Branch   string
	RemoteID int64
}

Repository defines runtime metadata for a repository.

type Step

type Step struct {
	Number   int64
	Started  time.Time
	Finished time.Time
}

Step defines runtime metadata for a step.

type System

type System struct {
	Name     string
	Host     string
	URL      string
	Platform string
	Version  string
}

System defines runtime metadata for a ci/cd system.