Documentation
¶
Index ¶
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.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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
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.
type Metadata ¶ added in v0.2.0
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 ¶ added in v0.23.0
PullRequest defines the data pulled from PRs while processing a webhook.
type Queue ¶ added in v0.2.0
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 Vela ¶ added in v0.2.0
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 ¶ added in v0.4.0
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 ¶ added in v0.5.0
ShouldSkip uses the build information associated with the given hook to determine whether the hook should be skipped.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package constants provides the defined constant types for Vela.
|
Package constants provides the defined constant types for Vela. |
|
Package database provides the defined database types for Vela.
|
Package database provides the defined database types for Vela. |
|
Package library provides the defined library types for Vela.
|
Package library provides the defined library types for Vela. |
|
actions
SPDX-License-Identifier: Apache-2.0
|
SPDX-License-Identifier: Apache-2.0 |
|
Package pipeline provides the defined pipeline types for Vela.
|
Package pipeline provides the defined pipeline types for Vela. |
|
Package raw provides the defined raw types for Vela.
|
Package raw provides the defined raw types for Vela. |
|
Package version provides the defined version types for Vela.
|
Package version provides the defined version types for Vela. |
|
Package yaml provides the defined yaml types for Vela.
|
Package yaml provides the defined yaml types for Vela. |