types

Documentation

Index

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

Constants

const ItemVersion uint64 = 2

ItemVersion allows the worker to detect items that were queued before an Vela server upgrade or downgrade, so it can handle such stale data gracefully. For example, the worker could fail a stale build or ask the server to recompile it. This is not a public API and is unrelated to the version key in pipeline yaml.

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"`
	Repo  *library.Repo  `json:"repo"`
	User  *library.User  `json:"user"`
	// The 0-value is the implicit ItemVersion for queued Items that pre-date adding the field.
	ItemVersion uint64 `json:"item_version"`
}

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

func ToItem

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

ToItem creates a queue item from a 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 PullRequest

type PullRequest struct {
	Comment    string
	Number     int
	IsFromFork bool
}

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

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

type Webhook

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

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.