bundle

Documentation

Index

• Constants
• func Export(yamlContent string, workspaceDir string, w io.Writer) error
• func ScanReferencedPaths(cfg *config.WorkflowConfig) []string
• type Manifest
  • func Import(r io.Reader, destDir string) (*Manifest, string, error)

Constants

const (
	// MaxBundleSize is the maximum total size of an extracted bundle (100MB).
	MaxBundleSize = 100 * 1024 * 1024
	// MaxFileSize is the maximum size of a single file in a bundle (10MB).
	MaxFileSize = 10 * 1024 * 1024
)

const BundleFormatVersion = "1.0"

BundleFormatVersion is the current bundle format version.

Functions

func Export

func Export(yamlContent string, workspaceDir string, w io.Writer) error

Export creates a tar.gz bundle from a workflow's YAML content and workspace directory.

func ScanReferencedPaths

func ScanReferencedPaths(cfg *config.WorkflowConfig) []string

ScanReferencedPaths examines a workflow config and returns relative paths that are explicitly referenced in module configurations.

Types

type Manifest

type Manifest struct {
	Version     string                 `json:"version"`
	Name        string                 `json:"name"`
	Description string                 `json:"description,omitempty"`
	Files       []string               `json:"files"`
	Requires    *config.RequiresConfig `json:"requires,omitempty"`
}

Manifest describes the contents of a workflow bundle.

func Import

func Import(r io.Reader, destDir string) (*Manifest, string, error)

Import extracts a tar.gz bundle to the destination directory. Returns the manifest, path to the extracted workflow.yaml, and any error.