drone

Documentation

Index

• type Author
• type Build
• type Calver
• type Commit
• type Deploy
• type Failed
• type Git
• type Message
• type Network
• type Pipeline
• type PullRequest
• type Repo
• type Semver
• type Stage
• type Step
• type System
• type Tag

Types

type Author

type Author struct {
	Username string
	Name     string
	Email    string
	Avatar   string
}

Author of a commit.

type Build

type Build struct {
	Branch   string
	Number   int
	Parent   int
	Event    string
	Action   string
	Status   string
	Created  time.Time
	Started  time.Time
	Finished time.Time
	Link     string
}

Build provides build metadata.

type Calver

type Calver struct {
	Version    string
	Short      string
	MajorMinor string
	Major      string
	Minor      string
	Micro      string
	Modifier   string
}

Calver provides the calver details parsed from the git tag. If the git tag is empty or is not a valid calver, the values will be empty.

type Commit

type Commit struct {
	Rev     string
	Before  string
	After   string
	Ref     string
	Branch  string
	Source  string
	Target  string
	Link    string
	Message Message
	Author  Author
}

Commit provides the commit metadata.

type Deploy

type Deploy struct {
	ID     string
	Target string
}

Deploy provides the deployment metadata.

type Failed

type Failed struct {
	Steps  []string
	Stages []string
}

Failed provides a list of failed steps and failed stages for the current pipeline.

type Git

type Git struct {
	HTTPURL string
	SSHURL  string
}

Git provides the git repository metadata.

type Message

type Message struct {
	Title string
	Body  string

} //

Message for a commit.

type Network

type Network struct {
	Context    context.Context
	SkipVerify bool
	Client     *http.Client
}

Network contains options for connecting to networks.

type Pipeline

type Pipeline struct {
	Build       Build
	Calver      Calver
	Commit      Commit
	Deploy      Deploy
	Failed      Failed
	Git         Git
	PullRequest PullRequest
	Repo        Repo
	Semver      Semver
	Stage       Stage
	Step        Step
	System      System
	Tag         Tag
}

Pipeline provides pipeline metadata from the environment.

type PullRequest

type PullRequest struct {
	Number int
}

PullRequest provides the pull request metadata.

type Repo

type Repo struct {
	Branch     string
	Link       string
	Namespace  string
	Name       string
	Private    bool
	Remote     string
	SCM        string
	Slug       string
	Visibility string
}

Repo provides the repository metadata.

type Semver

type Semver struct {
	Version    string
	Major      string
	Minor      string
	Patch      string
	PreRelease string
	Build      string
	Short      string
	Error      string
}

Semver provides the semver details parsed from the git tag. If the git tag is empty or is not a valid semver, the values will be empty and the error field will be populated with the parsing error.

type Stage

type Stage struct {
	Kind      string
	Type      string
	Name      string
	Number    int
	Machine   string
	OS        string
	Arch      string
	Variant   string
	Version   string
	Status    string
	Started   time.Time
	Finished  time.Time
	DependsOn []string
}

Stage provides the stage metadata.

type Step

type Step struct {
	Number int
	Name   string
}

Step provides the step metadata.

type System

type System struct {
	Proto    string
	Host     string
	Hostname string
	Version  string
}

System provides the Drone system metadata, including the system version of details required to create the drone website address.

type Tag

type Tag struct {
	Name string
}

Tag provides the git tag details.