stepid

Documentation

Index

• func Validate(compositeVersionString string) error
• type CanonicalID
  • func CreateCanonicalIDFromString(compositeVersionStr, defaultStepLibSource string) (CanonicalID, error)
  • func (sIDData CanonicalID) IsUniqueResourceID() bool

Functions

func Validate

func Validate(compositeVersionString string) error

Types

type CanonicalID

type CanonicalID struct {
	// steplib source uri, or in case of local path just "path", and in case of direct git url just "git"
	SteplibSource string
	// IDOrURI : ID if steplib is provided, URI if local step or in case a direct git url provided
	IDorURI string
	// Version : version in the steplib, or in case of a direct git step the tag-or-branch to use
	Version string
}

CanonicalID is a structured representation of a composite-step-id A composite step id is: step-lib-source::step-id@1.0.0

func CreateCanonicalIDFromString

func CreateCanonicalIDFromString(compositeVersionStr, defaultStepLibSource string) (CanonicalID, error)

compositeVersionStr examples:

• local path:
• path::~/path/to/step/dir
• direct git url and branch or tag:
• git::https://github.com/bitrise-io/steps-timestamp.git@master
• Steplib independent step:
• _::https://github.com/bitrise-io/steps-bash-script.git@2.0.0:
• full ID with steplib, stepid and version:
• https://github.com/bitrise-io/bitrise-steplib.git::script@2.0.0
• only stepid and version (requires a default steplib source to be provided):
• script@2.0.0
• only stepid, latest version will be used (requires a default steplib source to be provided):
• script

func (CanonicalID) IsUniqueResourceID

func (sIDData CanonicalID) IsUniqueResourceID() bool

IsUniqueResourceID : true if this ID is a unique resource ID, which is true if the ID refers to the exact same step code/data every time. Practically, this is only true for steps from StepLibrary collections, a local path or direct git step ID is never guaranteed to identify the same resource every time, the step's behaviour can change at every execution!

__If the ID is a Unique Resource ID then the step can be cached (locally)__, as it won't change between subsequent step execution.