config

Documentation

Index

• Variables
• type Binary
• type CustomTask
• type MageTagStruct

Variables

var (
	// RepoDir holds a repository path.
	RepoDir string

	// BuildDirPath holds a build dir path.
	BuildDirPath = []string{"build", "_output"}
	// MageTag holds default mage tag settings.
	MageTag = MageTagStruct{
		Color: color.FgCyan,
		Label: "[MAGE]",
	}

	// Dependencies will hold additional dependencies that needs to be installed
	// before running tasks.
	Dependencies = []string{
		"github.com/kyoh86/richgo",
		"github.com/mgechev/revive",
		"honnef.co/go/tools/cmd/staticcheck",
	}

	// VersionVariablePath a Golang path to version holding variable.
	VersionVariablePath string

	// Binaries a list of binaries to build.
	Binaries []Binary

	// CleaningTasks additional cleaning tasks.
	CleaningTasks []CustomTask

	// Checks holds a list of checks to perform.
	Checks []CustomTask
)

Types

type Binary

type Binary struct {
	Name string
}

Binary represents a binary that will be built.

type CustomTask

type CustomTask struct {
	Name string
	Task func() error
}

CustomTask is a custom function that will be used in the build.

type MageTagStruct

type MageTagStruct struct {
	Color color.Attribute
	Label string
}

MageTagStruct holds a mage tag.