platform

Documentation

Index

• Constants
• type Platform
  • func Auto() Platform
  • func NewUnix() Platform
  • func NewWindows(osVersion string) Platform
• type UnixPlatform
  • func (platform *UnixPlatform) AgentBinaryPath() string
  • func (platform *UnixPlatform) AgentImage(version string) string
  • func (platform *UnixPlatform) CopyCommand(populate bool) []string
  • func (platform *UnixPlatform) ProjectDirMountpoint() string
  • func (platform *UnixPlatform) WorkingVolumeMountpoint() string
• type WindowsPlatform
  • func (platform *WindowsPlatform) AgentBinaryPath() string
  • func (platform *WindowsPlatform) AgentImage(version string) string
  • func (platform *WindowsPlatform) CopyCommand(populate bool) []string
  • func (platform *WindowsPlatform) ProjectDirMountpoint() string
  • func (platform *WindowsPlatform) WorkingVolumeMountpoint() string

Constants

const (
	// WorkingVolumeWorkingDir is a working directory relative to the WorkingVolumeMountpoint().
	WorkingVolumeWorkingDir = "working-dir"

	// WorkingVolumeAgentBinary is the name of the agent binary relative to the WorkingVolumeMountpoint().
	WorkingVolumeAgentBinary = "cirrus-ci-agent"

	// AgentImageBase is used as a prefix to the agent's version to craft the full agent image name.
	AgentImageBase = "gcr.io/cirrus-ci-community/cirrus-ci-agent:v"

	// DefaultAgentVersion represents the default version of the https://github.com/cirruslabs/cirrus-ci-agent to use.
	DefaultAgentVersion = "1.26.0"
)

Types

type Platform

type Platform interface {
	// Where we will mount the project directory for further copying into a working volume
	ProjectDirMountpoint() string

	// Where working volume is mounted to when running Docker containers on Unix-like platforms.
	WorkingVolumeMountpoint() string

	AgentImage(version string) string

	CopyCommand(populate bool) []string

	AgentBinaryPath() string
}

func Auto

func Auto() Platform

func NewUnix

func NewUnix() Platform

func NewWindows

func NewWindows(osVersion string) Platform

type UnixPlatform

type UnixPlatform struct{}

func (*UnixPlatform) AgentBinaryPath

func (platform *UnixPlatform) AgentBinaryPath() string

func (*UnixPlatform) AgentImage

func (platform *UnixPlatform) AgentImage(version string) string

func (*UnixPlatform) CopyCommand

func (platform *UnixPlatform) CopyCommand(populate bool) []string

func (*UnixPlatform) ProjectDirMountpoint

func (platform *UnixPlatform) ProjectDirMountpoint() string

func (*UnixPlatform) WorkingVolumeMountpoint

func (platform *UnixPlatform) WorkingVolumeMountpoint() string

type WindowsPlatform

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

func (*WindowsPlatform) AgentBinaryPath

func (platform *WindowsPlatform) AgentBinaryPath() string

func (*WindowsPlatform) AgentImage

func (platform *WindowsPlatform) AgentImage(version string) string

func (*WindowsPlatform) CopyCommand

func (platform *WindowsPlatform) CopyCommand(populate bool) []string

func (*WindowsPlatform) ProjectDirMountpoint

func (platform *WindowsPlatform) ProjectDirMountpoint() string

func (*WindowsPlatform) WorkingVolumeMountpoint

func (platform *WindowsPlatform) WorkingVolumeMountpoint() string