v1alpha1

package
v0.37.0 Latest Latest
Warning

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

 Go to latest Published: Aug 12, 2025 License: Apache-2.0 Imports: 5 Imported by: 10

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeBuilder initializes a scheme builder.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a global function that registers this API group & version to a scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: pipelinesascode.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects.

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource.

Types

type GitProvider 

type GitProvider struct {
	// URL of the git provider API endpoint. This is the base URL for API requests to the
	// Git provider (e.g., 'https://api.github.com' for GitHub or a custom GitLab instance URL).
	// +optional
	URL string `json:"url,omitempty"`

	// User of the git provider. Username to use for authentication when using basic auth
	// or token-based authentication methods. Not used for GitHub Apps authentication.
	// +optional
	User string `json:"user,omitempty"`

	// Secret reference for authentication with the Git provider. Contains the token,
	// password, or private key used to authenticate requests to the Git provider API.
	// +optional
	Secret *Secret `json:"secret,omitempty"`

	// WebhookSecret reference for webhook validation. Contains the shared secret used to
	// validate that incoming webhooks are legitimate and coming from the Git provider.
	// +optional
	WebhookSecret *Secret `json:"webhook_secret,omitempty"`

	// Type of git provider. Determines which Git provider API and authentication flow to use.
	// Supported values:
	// - 'github': GitHub.com or GitHub Enterprise
	// - 'gitlab': GitLab.com or self-hosted GitLab
	// - 'bitbucket-datacenter': Bitbucket Data Center (self-hosted)
	// - 'bitbucket-cloud': Bitbucket Cloud (bitbucket.org)
	// - 'gitea': Gitea instances
	// +optional
	// +kubebuilder:validation:Enum=github;gitlab;bitbucket-datacenter;bitbucket-cloud;gitea
	Type string `json:"type,omitempty"`
}

func (*GitProvider) Merge added in v0.27.0 

func (g *GitProvider) Merge(newGitProvider *GitProvider)

type GithubSettings added in v0.36.0 

type GithubSettings struct {
	// CommentStrategy defines how GitLab comments are handled for pipeline results.
	// Options:
	// - 'disable_all': Disables all comments on merge requests
	// +optional
	// +kubebuilder:validation:Enum="";disable_all
	CommentStrategy string `json:"comment_strategy,omitempty"`
}

type GitlabSettings added in v0.34.0 

type GitlabSettings struct {
	// CommentStrategy defines how GitLab comments are handled for pipeline results.
	// Options:
	// - 'disable_all': Disables all comments on merge requests
	// +optional
	// +kubebuilder:validation:Enum="";disable_all
	CommentStrategy string `json:"comment_strategy,omitempty"`
}

type Incoming 

type Incoming struct {
	// Type of the incoming webhook. Currently only 'webhook-url' is supported, which allows
	// external systems to trigger PipelineRuns via generic webhook requests.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=webhook-url
	Type string `json:"type"`

	// Secret for the incoming webhook authentication. This secret is used to validate
	// that webhook requests are coming from authorized sources.
	// +kubebuilder:validation:Required
	Secret Secret `json:"secret"`

	// Params defines parameter names to extract from the webhook payload. These parameters
	// will be made available to the PipelineRuns triggered by this webhook.
	// +optional
	Params []string `json:"params,omitempty"`

	// Targets defines target branches for this webhook. When specified, only webhook
	// events targeting these branches will trigger PipelineRuns.
	// +optional
	Targets []string `json:"targets,omitempty"`
}

type Params added in v0.18.0 

type Params struct {
	// Name of the parameter. This is the key that will be used to reference this parameter
	// in PipelineRun definitions through via the {{ name }} syntax.
	// +kubebuilder:validation:Required
	Name string `json:"name"`

	// Value of the parameter. The literal value to be provided to the PipelineRun.
	// This field is mutually exclusive with SecretRef.
	// +optional
	Value string `json:"value,omitempty"`

	// SecretRef references a secret for the parameter value. Use this when the parameter
	// contains sensitive information that should not be stored directly in the Repository CR.
	// This field is mutually exclusive with Value.
	// +optional
	SecretRef *Secret `json:"secret_ref,omitempty"`

	// Filter defines when this parameter applies. It can be used to conditionally
	// apply parameters based on the event type, branch name, or other attributes.
	// +optional
	Filter string `json:"filter,omitempty"`
}

type Policy added in v0.20.0 

type Policy struct {
	// OkToTest defines a list of usernames that are allowed to trigger pipeline runs on pull requests
	// from external contributors by commenting "/ok-to-test" on the PR. These users are typically
	// repository maintainers or trusted contributors who can vouch for external contributions.
	// +optional
	OkToTest []string `json:"ok_to_test,omitempty"`

	// PullRequest defines a list of usernames that are explicitly allowed to execute
	// pipelines on their pull requests, even if they wouldn't normally have permission.
	// This is useful for allowing specific external contributors to trigger pipeline runs.
	// +optional
	PullRequest []string `json:"pull_request,omitempty"`
}

type Repository 

type Repository struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   RepositorySpec        `json:"spec"`
	Status []RepositoryRunStatus `json:"pipelinerun_status,omitempty"`
}

Repository is the representation of a Git repository from a Git provider platform. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Namespaced,shortName=repo +kubebuilder:printcolumn:name="URL",type=string,JSONPath=`.spec.url` +kubebuilder:printcolumn:name="Succeeded",type=string,JSONPath=`.pipelinerun_status[-1].conditions[?(@.type=="Succeeded")].status` +kubebuilder:printcolumn:name="Reason",type=string,JSONPath=`.pipelinerun_status[-1].conditions[?(@.type=="Succeeded")].reason` +kubebuilder:printcolumn:name="StartTime",type=date,JSONPath=`.pipelinerun_status[-1].startTime` +kubebuilder:printcolumn:name="CompletionTime",type=date,JSONPath=`.pipelinerun_status[-1].completionTime`

func (*Repository) DeepCopy 

func (in *Repository) DeepCopy() *Repository

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Repository.

func (*Repository) DeepCopyInto 

func (in *Repository) DeepCopyInto(out *Repository)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Repository) DeepCopyObject 

func (in *Repository) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RepositoryList 

type RepositoryList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Repository `json:"items"`
}

RepositoryList is the list of Repositories. +kubebuilder:object:root=true

func (*RepositoryList) DeepCopy 

func (in *RepositoryList) DeepCopy() *RepositoryList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryList.

func (*RepositoryList) DeepCopyInto 

func (in *RepositoryList) DeepCopyInto(out *RepositoryList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RepositoryList) DeepCopyObject 

func (in *RepositoryList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RepositoryRunStatus 

type RepositoryRunStatus struct {
	duckv1.Status `json:",inline"`

	// PipelineRunName is the name of the PipelineRun
	// +optional
	PipelineRunName string `json:"pipelineRunName,omitempty"`

	// StartTime is the time the PipelineRun is actually started.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CompletionTime is the time the PipelineRun completed.
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// SHA is the name of the SHA that has been tested
	// +optional
	SHA *string `json:"sha,omitempty"`

	// SHA the URL of the SHA to view it
	// +optional
	SHAURL *string `json:"sha_url,omitempty"`

	// Title is the title of the commit SHA that has been tested
	// +optional
	Title *string `json:"title,omitempty"`

	// LogURL is the full URL to the log for this run.
	// +optional
	LogURL *string `json:"logurl,omitempty"`

	// TargetBranch is the target branch of that run
	// +optional
	TargetBranch *string `json:"target_branch,omitempty"`

	// EventType is the event type of that run
	// +optional
	EventType *string `json:"event_type,omitempty"`

	// CollectedTaskInfos is the information about tasks
	CollectedTaskInfos *map[string]TaskInfos `json:"failure_reason,omitempty"`
}

func (*RepositoryRunStatus) DeepCopy 

func (in *RepositoryRunStatus) DeepCopy() *RepositoryRunStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositoryRunStatus.

func (*RepositoryRunStatus) DeepCopyInto 

func (in *RepositoryRunStatus) DeepCopyInto(out *RepositoryRunStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RepositorySpec 

type RepositorySpec struct {
	// ConcurrencyLimit defines the maximum number of concurrent pipelineruns that can
	// run for this repository. This helps prevent resource exhaustion when many events trigger
	// pipelines simultaneously.
	// +optional
	// +kubebuilder:validation:Minimum=1
	ConcurrencyLimit *int `json:"concurrency_limit,omitempty"` // move it to settings in further version of the spec

	// URL of the repository we are building. Must be a valid HTTP/HTTPS Git repository URL
	// that PAC will use to clone and fetch pipeline definitions from.
	// +optional
	URL string `json:"url"`

	// GitProvider details specific to a git provider configuration. Contains authentication,
	// API endpoints, and provider type information needed to interact with the Git service.
	// +optional
	GitProvider *GitProvider `json:"git_provider,omitempty"`

	// Incomings defines incoming webhook configurations. Each configuration specifies how to
	// handle external webhook requests that don't come directly from the primary Git provider.
	// +optional
	Incomings *[]Incoming `json:"incoming,omitempty"`

	// Params defines repository level parameters that can be referenced in PipelineRuns.
	// These parameters can be used as default values or configured for specific events.
	// +optional
	Params *[]Params `json:"params,omitempty"`

	// Settings contains the configuration settings for the repository, including
	// authorization policies, provider-specific configuration, and provenance settings.
	// +optional
	Settings *Settings `json:"settings,omitempty"`
}

RepositorySpec defines the desired state of a Repository, including its URL, Git provider configuration, and operational settings.

func (*RepositorySpec) DeepCopy 

func (in *RepositorySpec) DeepCopy() *RepositorySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RepositorySpec.

func (*RepositorySpec) DeepCopyInto 

func (in *RepositorySpec) DeepCopyInto(out *RepositorySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RepositorySpec) Merge added in v0.27.0 

func (r *RepositorySpec) Merge(newRepo RepositorySpec)

type Secret 

type Secret struct {
	// Name of the secret
	// +kubebuilder:validation:Required
	Name string `json:"name"`

	// Key in the secret
	// +optional
	Key string `json:"key"`
}

type Settings added in v0.19.0 

type Settings struct {
	// GithubAppTokenScopeRepos lists repositories that can access the GitHub App token when using the
	// GitHub App authentication method. This allows specific repositories to use tokens generated for
	// the GitHub App installation, useful for cross-repository access.
	// +optional
	GithubAppTokenScopeRepos []string `json:"github_app_token_scope_repos,omitempty"`

	// PipelineRunProvenance configures how PipelineRun definitions are fetched.
	// Options:
	// - 'source': Fetch definitions from the event source branch/SHA (default)
	// - 'default_branch': Fetch definitions from the repository default branch
	// +optional
	// +kubebuilder:validation:Enum=source;default_branch
	PipelineRunProvenance string `json:"pipelinerun_provenance,omitempty"`

	// Policy defines authorization policies for the repository, controlling who can
	// trigger PipelineRuns under different conditions.
	// +optional
	Policy *Policy `json:"policy,omitempty"`

	// Gitlab contains GitLab-specific settings for repositories hosted on GitLab.
	// +optional
	Gitlab *GitlabSettings `json:"gitlab,omitempty"`

	Github *GithubSettings `json:"github,omitempty"`
}

func (*Settings) Merge added in v0.27.0 

func (s *Settings) Merge(newSettings *Settings)

type TaskInfos added in v0.13.0 

type TaskInfos struct {
	Name           string       `json:"name"`
	Message        string       `json:"message,omitempty"`
	LogSnippet     string       `json:"log_snippet,omitempty"`
	Reason         string       `json:"reason,omitempty"`
	DisplayName    string       `json:"display_name,omitempty"`
	CompletionTime *metav1.Time `json:"completion_time,omitempty"`
}

TaskInfos contains information about a task.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.