internal

Documentation

Index

• func ParseYAML(data []byte) (*types.Build, []string, error)
• type Database
• type Installation
• type Metadata
• type PullRequest
• type Queue
• type Source
• type Vela
• type Webhook
  • func (w *Webhook) ShouldSkip() (bool, string)

Functions

func ParseYAML

func ParseYAML(data []byte) (*types.Build, []string, error)

ParseYAML is a helper function for transitioning teams away from legacy buildkite YAML parser.

Types

type Database

type Database struct {
	Driver string `json:"driver"`
	Host   string `json:"host"`
}

Database is the extra set of database data passed to the compiler.

type Installation

type Installation struct {
	Action              string
	ID                  int64
	Org                 string
	RepositoriesAdded   []string
	RepositoriesRemoved []string
}

Installation defines the data pulled from an installation while processing a webhook. Only applies to GitHub Apps.

type Metadata

type Metadata struct {
	Database *Database `json:"database"`
	Queue    *Queue    `json:"queue"`
	Source   *Source   `json:"source"`
	Vela     *Vela     `json:"vela"`
}

Metadata is the extra set of data passed to the compiler for converting a yaml configuration to an executable pipeline.

type PullRequest

type PullRequest struct {
	Comment string
	Number  int
	Labels  []string
}

PullRequest defines the data pulled from PRs while processing a webhook.

type Queue

type Queue struct {
	Channel string `json:"channel"`
	Driver  string `json:"driver"`
	Host    string `json:"host"`
}

Queue is the extra set of queue data passed to the compiler.

type Source

type Source struct {
	Driver string `json:"driver"`
	Host   string `json:"host"`
}

Source is the extra set of source data passed to the compiler.

type Vela

type Vela struct {
	Address              string        `json:"address"`
	WebAddress           string        `json:"web_address"`
	WebOauthCallbackPath string        `json:"web_oauth_callback_path"`
	AccessTokenDuration  time.Duration `json:"access_token_duration"`
	RefreshTokenDuration time.Duration `json:"refresh_token_duration"`
	OpenIDIssuer         string        `json:"oidc_issuer"`
}

Vela is the extra set of Vela data passed to the compiler.

type Webhook

type Webhook struct {
	Hook         *api.Hook
	Repo         *api.Repo
	Build        *api.Build
	PullRequest  PullRequest
	Deployment   *api.Deployment
	Installation *Installation
}

Webhook defines a struct that is used to return the required data when processing webhook event a for a source provider event.

func (*Webhook) ShouldSkip

func (w *Webhook) ShouldSkip() (bool, string)

ShouldSkip uses the build information associated with the given hook to determine whether the hook should be skipped.