utils

Documentation

Overview

Package utils provides utility fns for maru

Package utils provides utility fns for maru

Index

• func FormatEnvVar(name, value string) string
• func JoinURLRepoPath(currentURL *url.URL, includeFilePath string) (*url.URL, error)
• func MakeTempDir(basePath string) (string, error)
• func MergeEnv(env1, env2 []string) []string
• func ReadRemoteYaml(location string, destConfig any, auth map[string]string) (err error)
• func ReadYaml(path string, destConfig any) error
• func TemplateString[T any](setVariableMap variables.SetVariableMap[T], s string) string
• func TemplateTaskAction[T any](action types.Action, withs map[string]string, ...) (types.Action, error)
• func UseLogFile() error

Functions

func FormatEnvVar

func FormatEnvVar(name, value string) string

FormatEnvVar format environment variables replacing non-alphanumeric characters with underscores and adding INPUT_ prefix

func JoinURLRepoPath

func JoinURLRepoPath(currentURL *url.URL, includeFilePath string) (*url.URL, error)

JoinURLRepoPath joins a path in a URL (detecting the URL type)

func MakeTempDir

func MakeTempDir(basePath string) (string, error)

MakeTempDir creates a temp directory with the maru- prefix.

func MergeEnv

func MergeEnv(env1, env2 []string) []string

MergeEnv merges two environment variable arrays, replacing variables found in env2 with variables from env1 otherwise appending the variable from env1 to env2

func ReadRemoteYaml

func ReadRemoteYaml(location string, destConfig any, auth map[string]string) (err error)

ReadRemoteYaml makes a get request to retrieve a given file from a URL

func ReadYaml

func ReadYaml(path string, destConfig any) error

ReadYaml reads a yaml file and unmarshals it into a given config.

func TemplateString

func TemplateString[T any](setVariableMap variables.SetVariableMap[T], s string) string

TemplateString replaces ${...} with the value from the template map

func TemplateTaskAction

func TemplateTaskAction[T any](action types.Action, withs map[string]string, inputs map[string]types.InputParameter, setVarMap variables.SetVariableMap[T]) (types.Action, error)

TemplateTaskAction templates a task's actions with the given inputs and variables

func UseLogFile

func UseLogFile() error

UseLogFile writes output to stderr and a logFile.