package
0.0.10
Repository: https://github.com/jenkins-x/lighthouse-config.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package secret implements an agent to read and reload the secrets.

# Functions

AvailablePipelineAgentTypes returns a slice of all available pipeline agent types.
BranchRequirements partitions status contexts for a given org, repo branch into three buckets: - contexts that are always required to be present - contexts that are required, _if_ present - contexts that are always optional.
ClearCompiledRegexes removes compiled regexes from the presubmits, useful for testing when deep equality is needed between presubmits.
DefaultRerunCommandFor returns the default rerun command for the job with this name.
DefaultTriggerFor returns the default regexp string used to match comments that should trigger the job with this name.
Labels returns a string slice with label consts from kube.
Load loads and parses the config at path.
LoadYAMLConfig loads the configuration from the given data.
NewGitHubDeferredChangedFilesProvider uses a closure to lazily retrieve the file changes only if they are needed.
Path returns the value for the component's configPath if provided explicitly or default otherwise.
SetPostsubmitRegexes compiles and validates all the regular expressions for the provided postsubmits.
SetPresubmitRegexes compiles and validates all the regular expressions for the provided presubmits.
ValidateController validates the provided controller config.
VolumeMountPaths returns a string slice with *MountPath consts in it.
VolumeMounts returns a string slice with *MountName consts in it.

# Constants

BatchJob tests multiple unmerged PRs at the same time.
CreatedByLighthouse is added on resources created by Lighthosue.
DefaultClusterAlias specifies the default context for resources owned by jobs (pods/builds).
DefaultConfigPath will be used if a --config-path is unset.
JenkinsXAgent is the agent type for running Jenkins X pipelines.
LegacyDefaultAgent is a backwards compatible way of dealing with legacy cases of "tekton" as the default agent, but meaning Jenkins X.
LighthouseJobIDLabel is added in resources created by lighthouse and carries the ID of the LighthouseJob that the pod is fulfilling.
LighthouseJobTypeLabel is added in resources created by lighthouse and carries the job type (presubmit, postsubmit, periodic, batch) that the pod is running.
Possible types of merges for the GitHub merge API.
Possible types of merges for the GitHub merge API.
Possible types of merges for the GitHub merge API.
Periodic job means it runs on a time-basis, unrelated to git changes.
PostsubmitJob means it runs on each new commit.
PresubmitJob means it runs on unmerged PRs.
TektonPipelineAgent is the agent type for running Tekton Pipeline pipelines.

# Structs

Agent watches a path and automatically loads the config stored therein.
Branch holds protection policy overrides for a particular branch.
Brancher is for shared code between jobs that only run against certain branches.
BranchProtection specifies the global branch protection policy.
Branding holds branding configuration for deck.
Config is a read-only snapshot of the config.
ContextPolicy configures required github contexts.
Controller holds configuration applicable to all agent-specific prow controllers.
Deck holds config for deck.
Delta represents the before and after states of a Config change detected by the Agent.
ExternalAgentLog ensures an external agent like Jenkins can expose its logs in prow.
Gerrit is config for the gerrit controller.
GitHubOptions allows users to control how prow applications display GitHub website links.
JenkinsOperator is config for the jenkins-operator controller.
JobBase contains attributes common to all job types.
JobConfig is config for all prow jobs.
Keeper is config for the keeper pool.
KeeperContextPolicy configures options about how to handle various contexts.
KeeperContextPolicyOptions holds the default policy, and any org overrides.
KeeperMergeCommitTemplate holds templates to use for merge commits.
KeeperOrgContextPolicy overrides the policy for an org, and any repo overrides.
KeeperQuery is turned into a GitHub search query.
KeeperRepoContextPolicy overrides the policy for repo, and any branch overrides.
Org holds the default protection policy for an entire org, as well as any repo overrides.
OwnersDirBlacklist is used to configure which directories to ignore when searching for OWNERS{,_ALIAS} files in a repo.
Periodic runs on a timer.
Plank is config for the plank controller.
Policy for the config/org/repo/branch.
Postsubmit runs on push events.
Preset is intended to match the k8s' PodPreset feature, and may be removed if that feature goes beta.
Presubmit runs on PRs.
ProwConfig is config for all prow controllers.
PushGateway is a prometheus push gateway.
QueryMap is a struct mapping from "org/repo" -> KeeperQueries that apply to that org or repo.
RegexpChangeMatcher is for code shared between jobs that run only when certain files are changed.
Repo holds protection policy overrides for all branches in a repo, as well as specific branch overrides.
Reporter keeps various details for status reporting.
Restrictions limits who can merge Users and Teams items are appended to parent lists.
ReviewPolicy specifies github approval/review criteria.
Sinker is config for the sinker controller.
Spyglass holds config for Spyglass.
UtilityConfig holds decoration metadata, such as how to clone and additional containers/etc.

# Type aliases

ChangedFilesProvider returns a slice of modified files.
Getter returns the current Config in a thread-safe manner.
KeeperQueries is a KeeperQuery slice.
PipelineKind specifies how the job is triggered.
PubsubSubscriptions maps GCP projects to a list of Topics.
PullRequestMergeType inidicates the type of the pull request.