info

Documentation

Index

• Constants
• Variables
• func GetCurrentControllerName(ctx context.Context) string
• func GetNS(ctx context.Context) string
• func StoreCurrentControllerName(ctx context.Context, name string) context.Context
• func StoreNS(ctx context.Context, ns string) context.Context
• type ControllerInfo
  • func GetControllerInfoFromEnvOrDefault() *ControllerInfo
• type Event
  • func NewEvent() *Event
  • func (r *Event) DeepCopyInto(out *Event)
• type Info
  • func (i *Info) DeepCopy(out *Info)
• type KubeOpts
  • func (k *KubeOpts) AddFlags(cmd *cobra.Command)
• type PacOpts
  • func (p *PacOpts) AddFlags(cmd *cobra.Command) error
  • func (p *PacOpts) DeepCopy(out *PacOpts)
• type Provider
• type ProviderConfig
• type Request
• type State
• type TriggerType

Constants

const (
	DefaultPipelinesAscodeSecretName = "pipelines-as-code-secret"

	DefaultPipelinesAscodeConfigmapName = "pipelines-as-code"
)

Variables

var InstallNamespaces = []string{"openshift-pipelines", "pipelines-as-code"}

Functions

func GetCurrentControllerName

func GetCurrentControllerName(ctx context.Context) string

GetCurrentControllerName retrieves current controller name from the context.

func GetNS

func GetNS(ctx context.Context) string

GetNS gets namespace from context.

func StoreCurrentControllerName

func StoreCurrentControllerName(ctx context.Context, name string) context.Context

StoreCurrentControllerName stores current controller name in the context.

func StoreNS

func StoreNS(ctx context.Context, ns string) context.Context

StoreNS stores namespace in context.

Types

type ControllerInfo

type ControllerInfo struct {
	Name      string `json:"name"`
	Configmap string `json:"configmap"`
	Secret    string `json:"secret"`
}

func GetControllerInfoFromEnvOrDefault

func GetControllerInfoFromEnvOrDefault() *ControllerInfo

GetControllerInfoFromEnvOrDefault retrieves controller info from the env or use the defaults TODO: handles doublons when fallbacking in case there is multiple controllers but no env variable.

type Event

type Event struct {
	State
	Event interface{}

	// EventType is what coming from the provider header, i.e:
	// GitHub -> pull_request
	// GitLab -> Merge Request Hook
	// Incoming Webhook  -> incoming (always a push)
	// Usually used for payload filtering passed from trigger directly
	EventType string

	// Full request
	Request *Request

	// TriggerTarget stable field across providers, ie: on Gitlab, Github and
	// others it would be always be pull_request we can rely on to know if it's
	// a push or a pull_request
	// we need to merge this with the TriggerType type by doing a review of
	// every instance using this and adapt it.
	TriggerTarget string

	// Target PipelineRun, the target PipelineRun user request. Used in incoming webhook
	TargetPipelineRun string

	BaseBranch        string // branch against where we are making the PR
	DefaultBranch     string // master/main branches to know where things like the OWNERS file is located.
	HeadBranch        string // branch from where our SHA get tested
	BaseURL           string // url against where we are making the PR
	HeadURL           string // url from where our SHA get tested
	SHA               string
	Sender            string
	URL               string // WEB url not the git URL, which would match to the repo.spec
	SHAURL            string // pretty URL for web browsing for UIs (cli/web)
	SHATitle          string // commit title for UIs
	PullRequestNumber int    // Pull or Merge Request number
	PullRequestTitle  string // Title of the pull Request

	// TODO: move forge specifics to each driver
	// Github
	Organization   string
	Repository     string
	InstallationID int64
	GHEURL         string

	// TODO: move out inside the provider
	// Bitbucket Cloud
	AccountID string

	// TODO: move out inside the provider
	// Bitbucket Server
	CloneURL string // bitbucket server has a different url for cloning the repo than normal public html url
	Provider *Provider

	// Gitlab
	SourceProjectID int
	TargetProjectID int
}

func NewEvent

func NewEvent() *Event

NewEvent returns a new Event.

func (*Event) DeepCopyInto

func (r *Event) DeepCopyInto(out *Event)

DeepCopyInto deep copy runinfo in another instance.

type Info

type Info struct {
	Pac        *PacOpts
	Kube       *KubeOpts
	Controller *ControllerInfo
}

func (*Info) DeepCopy

func (i *Info) DeepCopy(out *Info)

type KubeOpts

type KubeOpts struct {
	ConfigPath string
	Context    string
	Namespace  string
}

func (*KubeOpts) AddFlags

func (k *KubeOpts) AddFlags(cmd *cobra.Command)

type PacOpts

type PacOpts struct {
	*settings.Settings
	WebhookType        string
	PayloadFile        string
	TektonDashboardURL string
}

func (*PacOpts) AddFlags

func (p *PacOpts) AddFlags(cmd *cobra.Command) error

func (*PacOpts) DeepCopy

func (p *PacOpts) DeepCopy(out *PacOpts)

type Provider

type Provider struct {
	Token                 string
	URL                   string
	User                  string
	WebhookSecret         string
	WebhookSecretFromRepo bool
}

type ProviderConfig

type ProviderConfig struct {
	TaskStatusTMPL string
	APIURL         string
	Name           string
	SkipEmoji      bool
}

type Request

type Request struct {
	Header  http.Header
	Payload []byte
}

type State

type State struct {
	TargetTestPipelineRun   string
	CancelPipelineRuns      bool
	TargetCancelPipelineRun string
}

type TriggerType

type TriggerType string

const (
	TriggerTypeOkToTest              TriggerType = "ok-to-test"
	TriggerTypeRetest                TriggerType = "retest"
	TriggerTypePush                  TriggerType = "push"
	TriggerTypePullRequest           TriggerType = "pull_request"
	TriggerTypeCancel                TriggerType = "cancel"
	TriggerTypeCheckSuiteRerequested TriggerType = "check-suite-rerequested"
	TriggerTypeCheckRunRerequested   TriggerType = "check-run-rerequested"
)