mgl

Documentation

Index

• type ArtifactInfos
• type DockerInfos
• type GitInfos
• type MageLibrary
  • func NewMageLibrary(workdir string, options ...MageLibraryOption) *MageLibrary
  • func (c *MageLibrary) ArtifactDetails(url, user string) *ArtifactInfos
  • func (c *MageLibrary) ChangeLog(filename string, artifactURL, gitURL string) error
  • func (c *MageLibrary) DockerDetails(registry, image, user string) *DockerInfos
  • func (c *MageLibrary) Format() error
  • func (c *MageLibrary) GitDetails() (*GitInfos, error)
  • func (c *MageLibrary) InstallDeps() error
  • func (c *MageLibrary) Lint() error
  • func (c *MageLibrary) PackageDetails() (*PackageInfos, error)
  • func (c *MageLibrary) Version() string
  • func (c *MageLibrary) Vet() error
  • func (c *MageLibrary) Workdir() string
• type MageLibraryOption
• type PackageInfos

Types

type ArtifactInfos

type ArtifactInfos struct {
	URL string
	Usr string
	Pwd string
	// contains filtered or unexported fields
}

ArtifactInfos holds information regarding artifacts registry

type DockerInfos

type DockerInfos struct {
	Registry string
	Image    string
	Usr      string
	Pwd      string
	// contains filtered or unexported fields
}

DockerInfos holds information regarding docker

type GitInfos

type GitInfos struct {
	Rev            string
	TagAtRev       string
	LatestTag      string
	RevAtLatestTag string
	// contains filtered or unexported fields
}

GitInfos holds information regarding git

type MageLibrary

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

MageLibrary provides Mage independent functions to build its own targets

func NewMageLibrary

func NewMageLibrary(workdir string, options ...MageLibraryOption) *MageLibrary

NewMageLibrary constructs new MageLibrary instance

func (*MageLibrary) ArtifactDetails

func (c *MageLibrary) ArtifactDetails(url, user string) *ArtifactInfos

ArtifactDetails aggregates the information regarding artifacts registry

func (*MageLibrary) ChangeLog

func (c *MageLibrary) ChangeLog(filename string, artifactURL, gitURL string) error

ChangeLog generates a ChangeLog based on git history

func (*MageLibrary) DockerDetails

func (c *MageLibrary) DockerDetails(registry, image, user string) *DockerInfos

DockerDetails aggregates the information regarding docker

func (*MageLibrary) Format

func (c *MageLibrary) Format() error

Format formats code via gofmt

func (*MageLibrary) GitDetails

func (c *MageLibrary) GitDetails() (*GitInfos, error)

GitDetails aggregates the information regarding git

func (*MageLibrary) InstallDeps

func (c *MageLibrary) InstallDeps() error

InstallDeps installs the additional dependencies: goimports & golint

func (*MageLibrary) Lint

func (c *MageLibrary) Lint() error

Lint runs golint linter

func (*MageLibrary) PackageDetails

func (c *MageLibrary) PackageDetails() (*PackageInfos, error)

PackageDetails aggregates the package information regarding the go project

func (*MageLibrary) Version

func (c *MageLibrary) Version() string

Version extracts version from git tag

func (*MageLibrary) Vet

func (c *MageLibrary) Vet() error

Vet runs go vet linter

func (*MageLibrary) Workdir

func (c *MageLibrary) Workdir() string

Workdir returns the workdir used

type MageLibraryOption

type MageLibraryOption func(*MageLibrary)

MageLibraryOption defines an operation which set an option

type PackageInfos

type PackageInfos struct {
	Names []string
	// contains filtered or unexported fields
}

PackageInfos holds information regarding the go project