mgp

Documentation

Index

• type MageProject
  • func InitMageProject(workdir string, proj *MageProject) *MageProject
  • func (p *MageProject) Build() error
  • func (p *MageProject) Clean() error
  • func (p *MageProject) DockerBuild() error
  • func (p *MageProject) DockerPush() error
  • func (p *MageProject) MageLibrary() *mgl.MageLibrary
  • func (p *MageProject) Package() error
  • func (p *MageProject) PrintInfo()
  • func (p *MageProject) Test() error
  • func (p *MageProject) Validate() error

Types

type MageProject

type MageProject struct {
	ProjectName string
	GroupName   string
	BuildDir    string
	PackageName string
	LdFlags     string
	DckRegistry string
	DckImage    string
	ArtifactURL string
	GitURL      string
	// contains filtered or unexported fields
}

MageProject provides Mage dependent high level targets to reuse as is

func InitMageProject

func InitMageProject(workdir string, proj *MageProject) *MageProject

InitMageProject initializes MageProject

func (*MageProject) Build

func (p *MageProject) Build() error

Build builds binary in build dir

func (*MageProject) Clean

func (p *MageProject) Clean() error

Clean removes the build directory

func (*MageProject) DockerBuild

func (p *MageProject) DockerBuild() error

DockerBuild builds Docker image

func (*MageProject) DockerPush

func (p *MageProject) DockerPush() error

DockerPush pushes Docker image to artifacts repository

func (*MageProject) MageLibrary

func (p *MageProject) MageLibrary() *mgl.MageLibrary

MageLibrary gets Mage library used by this project

func (*MageProject) Package

func (p *MageProject) Package() error

Package packages cross platform binaries in build dir

func (*MageProject) PrintInfo

func (p *MageProject) PrintInfo()

PrintInfo prints information used internally

func (*MageProject) Test

func (p *MageProject) Test() error

Test runs tests with go test

func (*MageProject) Validate

func (p *MageProject) Validate() error

Validate runs go format and linters