variables

Documentation

Overview

package variables implements a type and functions to handle CI job variables as described in https://docs.gitlab.com/ee/ci/variables. This includes handling file-type variables and (eventually) masked variables. It is analogous to, but a subset/simplification of, https://gitlab.com/gitlab-org/gitlab-runner/-/blob/main/common/variables.go. This includes things like expanding variables and writing file-type variables to file.

Index

• func Prepare(pjob *proto.Job, tmpPath string) (map[string]string, error)
• type Variable
  • func (v *Variable) File() bool
  • func (v *Variable) Key() string
  • func (v *Variable) Masked() bool
  • func (v *Variable) Value() string
  • func (v *Variable) Write() error
• type Variables
  • func New(vars []*proto.Variable, tmpPath string) Variables
  • func (vs *Variables) Write() error

Functions

func Prepare

func Prepare(pjob *proto.Job, tmpPath string) (map[string]string, error)

Types

type Variable

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

func (*Variable) File

func (v *Variable) File() bool

func (*Variable) Key

func (v *Variable) Key() string

func (*Variable) Masked

func (v *Variable) Masked() bool

func (*Variable) Value

func (v *Variable) Value() string

File type variables return the full path to the file instead of the value.

func (*Variable) Write

func (v *Variable) Write() error

type Variables

type Variables []Variable

func New

func New(vars []*proto.Variable, tmpPath string) Variables

func (*Variables) Write

func (vs *Variables) Write() error