features

Documentation

Index

• func ArtifactCreator(artifactDir string, bindToPath string, envToSet string) runner.Feature
• func ArtifactImporter(artifactDir string, artifacts ...string) runner.Feature
• func ConsoleLogger() runner.Feature
• func DependsOn(progressHandle ProgressHandle) runner.Feature
• func Dryrun(dryrun bool) runner.Feature
• func Reuse(reuse bool) runner.Feature
• func SBOMDetector(directory string, sbom *SBOM) runner.Feature
• func StatusLogger(contextName string) runner.Feature
• func TUILogger(planID string) runner.Feature
• func TracePlan() runner.Feature
• func WorkingDirImporter(workingDir string, cacheDir string, bindWorkingDir bool, sharedCompute bool, ...) runner.Feature
• type PlanTracker
  • func (pt *PlanTracker) ProgressHandle(planID string) ProgressHandle
• type ProgressHandle
• type SBOM
• type SBOMType

Functions

func ArtifactCreator

func ArtifactCreator(artifactDir string, bindToPath string, envToSet string) runner.Feature

ArtifactCreator zip up an artifact with all files added to the output directory from the action

func ArtifactImporter

func ArtifactImporter(artifactDir string, artifacts ...string) runner.Feature

ArtifactImporter imports artifacts from a directory into the container

func ConsoleLogger

func ConsoleLogger() runner.Feature

ConsoleLogger is a Feature to capture simple logs

func DependsOn

func DependsOn(progressHandle ProgressHandle) runner.Feature

DependsOn waits for dependencies

func Dryrun

func Dryrun(dryrun bool) runner.Feature

Dryrun is a Feature to skip execution when dryrun is true

func Reuse

func Reuse(reuse bool) runner.Feature

Reuse provides a Feature to configure whether a plan is executed with reused containers

func SBOMDetector

func SBOMDetector(directory string, sbom *SBOM) runner.Feature

SBOMDetector is an [ExecutionFeature] to detect SBOMs created by actions. The content of the detected SBOM is loaded into the sbom provided.

func StatusLogger

func StatusLogger(contextName string) runner.Feature

StatusLogger is a Feature to configure logging of the result of a plan execution

func TUILogger

func TUILogger(planID string) runner.Feature

TUILogger is a Feature to display a UI

func TracePlan

func TracePlan() runner.Feature

TracePlan is a feature to trace the runtime of an action

func WorkingDirImporter

func WorkingDirImporter(workingDir string, cacheDir string, bindWorkingDir bool, sharedCompute bool, isWorkingDirSetup *bool) runner.Feature

WorkingDirImporter is a Feature that creates FileMaps to bind or copy the working directory to the environment used to execute a Plan.

Types

type PlanTracker

type PlanTracker struct {
	// contains filtered or unexported fields
}

PlanTracker provides ProgressHandle for each plan and tracks progress across all plans

func (*PlanTracker) ProgressHandle

func (pt *PlanTracker) ProgressHandle(planID string) ProgressHandle

ProgressHandle returns a ProgressHandle for the given plan.

type ProgressHandle

type ProgressHandle interface {
	Success()                                  // success is called when the handle completes successfully
	Failure(err error)                         // failure is called when the handle completes unsuccessfully
	IsReady(dependsOn ...string) (bool, error) // isReady is called to determine if the handle is ready
}

ProgressHandle handles callbacks from the progress on a plan execution

type SBOM

type SBOM struct {
	Type    SBOMType // type of SBOM
	Content []byte   // content of the SBOM
}

SBOM represents a detected SBOM (Software Bill of Materials)

type SBOMType

type SBOMType string

SBOMType - Currently only SPDX is supported

const (
	// SBOMTypeSPDX is the SPDX SBOM type
	SBOMTypeSPDX SBOMType = "https://spdx.dev/Document"
)