config

Documentation

Overview

Package config contains configuration strings for maru

Index

• Constants
• Variables
• func AddExtraEnv(key string, value string)
• func ClearExtraEnv()
• func GetArch(archs ...string) string
• func GetExtraEnv() map[string]string

Constants

const (
	// TasksYAML is the string for the default tasks.yaml
	TasksYAML = "tasks.yaml"

	// EnvPrefix is the prefix for environment variables
	EnvPrefix = "MARU"
)

Variables

var (
	// CLIArch is the computer architecture of the device executing the CLI commands
	CLIArch string

	// CLIVersion track the version of the CLI
	CLIVersion = "unset"

	// CmdPrefix is used to prefix Zarf cmds (like wait-for), useful when vendoring both the runner and Zarf
	// if not set, the system Zarf will be used
	CmdPrefix string

	// TaskFileLocation is the location of the tasks file to run
	TaskFileLocation string

	// TempDirectory is the directory to store temporary files
	TempDirectory string

	// VendorPrefix is the prefix for environment variables that an application vendoring Maru wants to use
	VendorPrefix string

	// MaxStack is the maximum stack size for task references
	MaxStack = 2048
)

Functions

func AddExtraEnv

func AddExtraEnv(key string, value string)

AddExtraEnv adds a new envirmentment variable to the extraEnv to make it available to actions

func ClearExtraEnv

func ClearExtraEnv()

ClearExtraEnv clears extraEnv back to empty map

func GetArch

func GetArch(archs ...string) string

GetArch returns the arch based on a priority list with options for overriding.

func GetExtraEnv

func GetExtraEnv() map[string]string

GetExtraEnv returns the map of extra environment variables that have been set and made available to actions