build

Documentation

Overview

Package build provides the algorithm for building yb targets.

Index

• func ContainerIPEnvVar(resourceName string) string
• func Execute(ctx context.Context, sys Sys, announce func(string), target *yb.Target) (err error)
• func Setup(ctx context.Context, sys Sys, target *yb.Target) (_ biome.BiomeCloser, err error)
• type Sys

Functions

func ContainerIPEnvVar

func ContainerIPEnvVar(resourceName string) string

ContainerIPEnvVar returns the name of the environment variable that optionally provides the IP address of a target's resource.

func Execute

func Execute(ctx context.Context, sys Sys, announce func(string), target *yb.Target) (err error)

Execute runs the given phase. It assumes that the phase's dependencies are already available in the biome.

announce is called before every command run if not nil.

func Setup

func Setup(ctx context.Context, sys Sys, target *yb.Target) (_ biome.BiomeCloser, err error)

Setup arranges for the phase's dependencies to be available, returning a new biome that has the dependencies configured. It is the caller's responsibility to call Close on the returned biome.

Types

type Sys

type Sys = buildpack.Sys

Sys holds dependencies provided by the caller needed to run builds.