function

Documentation

Index

• func Always() expr.Option
• func ChartFrom(ctx context.Context, c client.Client, project string, ...) expr.Option
• func CommitFrom(ctx context.Context, c client.Client, project string, ...) expr.Option
• func ConfigMap(ctx context.Context, c client.Client, project string) expr.Option
• func DataOperations(ctx context.Context, c client.Client, project string) []expr.Option
• func Failure(stepExecMetas kargoapi.StepExecutionMetadataList) expr.Option
• func FreightOperations(ctx context.Context, c client.Client, project string, ...) []expr.Option
• func ImageFrom(ctx context.Context, c client.Client, project string, ...) expr.Option
• func Secret(ctx context.Context, c client.Client, project string) expr.Option
• func Status(currentStepAlias string, stepExecMetas kargoapi.StepExecutionMetadataList) expr.Option
• func StatusOperations(currentStepAlias string, stepExecMetas kargoapi.StepExecutionMetadataList) []expr.Option
• func Success(stepExecMetas kargoapi.StepExecutionMetadataList) expr.Option
• func Warehouse() expr.Option

Functions

func Always

func Always() expr.Option

Always returns an expr.Option that provides an `always()` function for use in expressions.

The `always()` function unconditionally returns true.

func ChartFrom

func ChartFrom(
	ctx context.Context,
	c client.Client,
	project string,
	freightReqs []kargoapi.FreightRequest,
	freightRefs []kargoapi.FreightReference,
) expr.Option

ChartFrom returns an expr.Option that provides a `chartFrom()` function for use in expressions.

The chartFrom function finds Helm charts based on repository URL, optional chart name, and optional origin, using the provided freight requests and references within the project context.

func CommitFrom

func CommitFrom(
	ctx context.Context,
	c client.Client,
	project string,
	freightReqs []kargoapi.FreightRequest,
	freightRefs []kargoapi.FreightReference,
) expr.Option

CommitFrom returns an expr.Option that provides a `commitFrom()` function for use in expressions.

The commitFrom function finds Git commits based on repository URL and optional origin, using the provided freight requests and references within the project context.

func ConfigMap

func ConfigMap(ctx context.Context, c client.Client, project string) expr.Option

ConfigMap returns an expr.Option that provides a `configMap()` function for use in expressions.

func DataOperations

func DataOperations(ctx context.Context, c client.Client, project string) []expr.Option

DataOperations returns a slice of expr.Option containing functions for data operations, such as accessing ConfigMaps and Secrets.

func Failure

func Failure(stepExecMetas kargoapi.StepExecutionMetadataList) expr.Option

Failure returns an expr.Option that provides a `failure()` function for use in expressions.

The `failure()` function checks the status of all preceding steps and returns true if any of them have failed or errored and false otherwise.

func FreightOperations

func FreightOperations(
	ctx context.Context,
	c client.Client,
	project string,
	freightRequests []kargoapi.FreightRequest,
	freightRefs []kargoapi.FreightReference,
) []expr.Option

FreightOperations returns a slice of expr.Option containing functions for Freight operations.

It provides `warehouse()`, `commitFrom()`, `imageFrom()`, and `chartFrom()` functions that can be used within expressions. The functions operate within the context of a given project with the provided freight requests and references.

func ImageFrom

func ImageFrom(
	ctx context.Context,
	c client.Client,
	project string,
	freightReqs []kargoapi.FreightRequest,
	freightRefs []kargoapi.FreightReference,
) expr.Option

ImageFrom returns an expr.Option that provides an `imageFrom()` function for use in expressions.

The imageFrom function finds container images based on repository URL and optional origin, using the provided freight requests and references within the project context.

func Secret

func Secret(ctx context.Context, c client.Client, project string) expr.Option

Secret returns an expr.Option that provides a `secret()` function for use in expressions.

func Status

func Status(
	currentStepAlias string,
	stepExecMetas kargoapi.StepExecutionMetadataList,
) expr.Option

func StatusOperations

func StatusOperations(
	currentStepAlias string,
	stepExecMetas kargoapi.StepExecutionMetadataList,
) []expr.Option

StatusOperations returns a slice of expr.Option containing functions for assessing the status of all preceding steps.

func Success

func Success(stepExecMetas kargoapi.StepExecutionMetadataList) expr.Option

Success returns an expr.Option that provides a `success()` function for use in expressions.

The `success()` function checks the status of all preceding steps and returns true if none of them have failed or errored and false otherwise.

func Warehouse

func Warehouse() expr.Option

Warehouse returns an expr.Option that provides a `warehouse()` function for use in expressions.

The warehouse function creates a v1alpha1.FreightOrigin of kind v1alpha1.Warehouse with the specified name.