types

Documentation

Index

• type Database
• type Error
  • func (e *Error) String() string
• type Item
  • func ToItem(p *pipeline.Build, b *library.Build, r *library.Repo, u *library.User) *Item
• type Metadata
• type Queue
• type Source
• type Vela
• type Webhook
  • func (w *Webhook) ShouldSkip() (bool, string)

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 Error

type Error struct {
	Message *string `json:"error"`
}

Error is the json error message from the server for a given http response.

swagger:model Error

func (*Error) String

func (e *Error) String() string

type Item

type Item struct {
	Build    *library.Build  `json:"build"`
	Pipeline *pipeline.Build `json:"pipeline"`
	Repo     *library.Repo   `json:"repo"`
	User     *library.User   `json:"user"`
}

Item is the queue representation of an item to publish to the queue.

func ToItem

func ToItem(p *pipeline.Build, b *library.Build, r *library.Repo, u *library.User) *Item

ToItem creates a queue item from a pipeline, build, repo and user.

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 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"`
}

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

type Webhook

type Webhook struct {
	Comment  string
	PRNumber int
	Hook     *library.Hook
	Repo     *library.Repo
	Build    *library.Build
}

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.