step

Documentation

Overview

Package step provides the ability for Vela to manipulate and manage a step from a pipeline.

Usage:

import "github.com/go-vela/worker/internal/step"

Index

• func Environment(c *pipeline.Container, b *library.Build, r *library.Repo, s *library.Step, ...) error
• func Load(c *pipeline.Container, m *sync.Map) (*library.Step, error)
• func LoadInit(p *pipeline.Build) (*pipeline.Container, error)
• func LoadLogs(c *pipeline.Container, m *sync.Map) (*library.Log, error)
• func Skip(c *pipeline.Container, b *library.Build, r *library.Repo) bool
• func Snapshot(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, ...)
• func SnapshotInit(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, ...)
• func Upload(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, ...)

Functions

func Environment

func Environment(c *pipeline.Container, b *library.Build, r *library.Repo, s *library.Step, version string) error

Environment attempts to update the environment variables for the container based off the library resources.

nolint: lll // ignore long line length due to parameters

func Load

func Load(c *pipeline.Container, m *sync.Map) (*library.Step, error)

Load attempts to capture the library step representing the container from the map.

func LoadInit

func LoadInit(p *pipeline.Build) (*pipeline.Container, error)

LoadInit attempts to capture the container representing the init process from the pipeline.

func LoadLogs

func LoadLogs(c *pipeline.Container, m *sync.Map) (*library.Log, error)

LoadLogs attempts to capture the library step logs representing the container from the map.

func Skip

func Skip(c *pipeline.Container, b *library.Build, r *library.Repo) bool

Skip creates the ruledata from the build and repository information and returns true if the data does not match the ruleset for the given container.

func Snapshot

func Snapshot(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, r *library.Repo, s *library.Step)

Snapshot creates a moment in time record of the step and attempts to upload it to the server.

nolint: lll // ignore long line length due to parameters

func SnapshotInit

func SnapshotInit(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, r *library.Repo, s *library.Step, lg *library.Log)

SnapshotInit creates a moment in time record of the init step and attempts to upload it to the server.

nolint: lll // ignore long line length due to parameters

func Upload

func Upload(ctn *pipeline.Container, b *library.Build, c *vela.Client, l *logrus.Entry, r *library.Repo, s *library.Step)

Upload tracks the final state of the step and attempts to upload it to the server.

nolint: lll // ignore long line length due to parameters