pipeline

package
v0.1.33128 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2025 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewPipelineRestClient

func NewPipelineRestClient(config settings.Config) (*pipelineRestClient, error)

NewPipelineRestClient returns a new pipelineRestClient satisfying the api.PipelineInterface interface via the REST API.

Types

type Checkout added in v0.1.32367

type Checkout struct {
	Branch string `json:"branch,omitempty"`
	Tag    string `json:"tag,omitempty"`
}

type CheckoutSource

type CheckoutSource struct {
	Provider string `json:"provider"`
	Repo     Repo   `json:"repo"`
}

type CheckoutSourceResponse

type CheckoutSourceResponse struct {
	Provider string       `json:"provider"`
	Repo     RepoResponse `json:"repo"`
}

type Config added in v0.1.32367

type Config struct {
	Branch  string `json:"branch,omitempty"`
	Tag     string `json:"tag,omitempty"`
	Content string `json:"content,omitempty"`
}

type ConfigSource

type ConfigSource struct {
	Provider string `json:"provider"`
	Repo     Repo   `json:"repo"`
	FilePath string `json:"file_path"`
}

type ConfigSourceResponse

type ConfigSourceResponse struct {
	Provider string       `json:"provider"`
	Repo     RepoResponse `json:"repo"`
	FilePath string       `json:"file_path"`
}

type CreatePipelineInfo

type CreatePipelineInfo struct {
	Id                         string
	Name                       string
	CheckoutSourceRepoFullName string
	ConfigSourceRepoFullName   string
}

type GetPipelineDefinitionOptions added in v0.1.32145

type GetPipelineDefinitionOptions struct {
	ProjectID            string
	PipelineDefinitionID string
}

type GetPipelineDefinitionResponse added in v0.1.32145

type GetPipelineDefinitionResponse struct {
	ID             string                 `json:"id"`
	Name           string                 `json:"name"`
	Description    string                 `json:"description"`
	CreatedAt      string                 `json:"created_at"`
	ConfigSource   ConfigSourceResponse   `json:"config_source"`
	CheckoutSource CheckoutSourceResponse `json:"checkout_source"`
}

type PipelineClient

type PipelineClient interface {
	CreatePipeline(projectID string, name string, description string, repoID string, configRepoID string, filePath string) (*CreatePipelineInfo, error)
	GetPipelineDefinition(options GetPipelineDefinitionOptions) (*PipelineDefinition, error)
	ListPipelineDefinitions(projectID string) ([]*PipelineDefinitionInfo, error)
	PipelineRun(options PipelineRunOptions) (*PipelineRunResponse, error)
}

PipelineClient is the interface to interact with pipeline and it's components.

type PipelineDefinition added in v0.1.32145

type PipelineDefinition struct {
	ConfigSourceId   string
	CheckoutSourceId string
}

type PipelineDefinitionInfo added in v0.1.32219

type PipelineDefinitionInfo struct {
	ID             string                 `json:"id"`
	Name           string                 `json:"name"`
	Description    string                 `json:"description"`
	ConfigSource   ConfigSourceResponse   `json:"config_source"`
	CheckoutSource CheckoutSourceResponse `json:"checkout_source"`
}

PipelineDefinitionInfo represents a pipeline definition in a project

type PipelineRunCreatedResponse added in v0.1.32367

type PipelineRunCreatedResponse struct {
	State     string `json:"state"`
	CreatedAt string `json:"created_at"`
	Number    int    `json:"number"`
	ID        string `json:"id"`
}

type PipelineRunMessageResponse added in v0.1.32367

type PipelineRunMessageResponse struct {
	Message string `json:"message"`
}

type PipelineRunOptions added in v0.1.32367

type PipelineRunOptions struct {
	Project              string
	PipelineDefinitionID string
	Organization         string
	ConfigBranch         string
	ConfigTag            string
	CheckoutBranch       string
	CheckoutTag          string
	Parameters           map[string]interface{}
	ConfigFilePath       string
}

type PipelineRunResponse added in v0.1.32367

type PipelineRunResponse struct {
	Created *PipelineRunCreatedResponse
	Message *PipelineRunMessageResponse
}

type Repo

type Repo struct {
	ExternalID string `json:"external_id"`
}

type RepoResponse

type RepoResponse struct {
	ExternalID string `json:"external_id"`
	FullName   string `json:"full_name"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL