domain

Documentation

Index

• type Artifact
  • func ParseArtifact(artifactName string) (Artifact, error)
  • func (ea Artifact) String() string
  • func (ea Artifact) StringCanonical() string
• type Target
  • func JoinTargets(target1 Target, target2 Target) (Target, error)
  • func ParseTarget(fullTargetName string) (Target, error)
  • func (et Target) DebugString() string
  • func (et Target) IsExternal() bool
  • func (et Target) IsLocalExternal() bool
  • func (et Target) IsLocalInternal() bool
  • func (et Target) IsRemote() bool
  • func (et Target) ProjectCanonical() string
  • func (et Target) String() string
  • func (et Target) StringCanonical() string

Types

type Artifact

type Artifact struct {
	Target   Target
	Artifact string
}

Artifact is an earthly artifact identifier.

func ParseArtifact

func ParseArtifact(artifactName string) (Artifact, error)

ParseArtifact parses a string representation of a Artifact.

func (Artifact) String

func (ea Artifact) String() string

String returns a string representation of the Artifact.

func (Artifact) StringCanonical

func (ea Artifact) StringCanonical() string

StringCanonical returns a string representation of the Artifact.

type Target

type Target struct {
	GitURL string // e.g. "github.com/earthly/earthly/examples/go"
	Tag    string // e.g. "main"

	// Local representation.
	LocalPath string `json:"localPath"`

	// Target name.
	Target string `json:"target"`
}

Target is an earthly target identifier.

func JoinTargets

func JoinTargets(target1 Target, target2 Target) (Target, error)

JoinTargets returns the result of interpreting target2 as relative to target1.

func ParseTarget

func ParseTarget(fullTargetName string) (Target, error)

ParseTarget parses a string into a Target.

func (Target) DebugString

func (et Target) DebugString() string

DebugString returns a string that can be printed out for debugging purposes

func (Target) IsExternal

func (et Target) IsExternal() bool

IsExternal returns whether the target is external to the current project.

func (Target) IsLocalExternal

func (et Target) IsLocalExternal() bool

IsLocalExternal returns whether the target is a local, but external target.

func (Target) IsLocalInternal

func (et Target) IsLocalInternal() bool

IsLocalInternal returns whether the target is a local.

func (Target) IsRemote

func (et Target) IsRemote() bool

IsRemote returns whether the target is remote.

func (Target) ProjectCanonical

func (et Target) ProjectCanonical() string

ProjectCanonical returns a string representation of the project of the target, in canonical form.

func (Target) String

func (et Target) String() string

String returns a string representation of the Target.

func (Target) StringCanonical

func (et Target) StringCanonical() string

StringCanonical returns a string representation of the Target, in canonical form.