mymg

README

mymg

Overlay to mage that provides a setup defined framework to build and deploy Go projects

Documentation

Index

• func Auto() error
• func AutoStatus() error
• func Build() error
• func BuildCross() error
• func BumpVersion() error
• func Clean()
• func Comment()
• func Convert()
• func Display()
• func Format() error
• func GenConf()
• func Help()
• func Install() error
• func Lint() error
• func NoAuto() error
• func PPK() error
• func Release() error
• func Targets()
• func Test() error
• func Vet() error
• type Apps
• type Artifactories
• type ArtifactoryData
• type BuildData
• type Config
• type GenConfig
• type PostClean
• type Project
• type Projects
• type SCPCustoms
• type SCPs
• type SFTPs
• type ScpCustom
• type ScpData
  • func (s *ScpData) UnmarshalJSON(data []byte) error
• type SftpData

Functions

func Auto

func Auto() error

func AutoStatus

func AutoStatus() error

func Build

func Build() error

A build step that requires additional params, or platform specific steps for example

func BuildCross

func BuildCross() error

func BumpVersion

func BumpVersion() error

func Clean

func Clean()

func Comment

func Comment()

func Convert

func Convert()

func Display

func Display()

func Format

func Format() error

Format your go code

func GenConf

func GenConf()

func Help

func Help()

func Install

func Install() error

func Lint

func Lint() error

Perform Lint checks on your project

func NoAuto

func NoAuto() error

func PPK

func PPK() error

Used with Ping on SCP, host must be available via ping check, requires ppk setup

func Release

func Release() error

func Targets

func Targets()

func Test

func Test() error

Run Tests on your project

func Vet

func Vet() error

Vet your code

Types

type Apps

type Apps struct {
	MD5Exe    string `json:"md5Exe" toml:"md5Exe"`
	SHA1Exe   string `json:"sha1Exe" toml:"sha1Exe"`
	SHA256Exe string `json:"sha256Exe" toml:"sha256Exe"`
	CurlExe   string `json:"curlExe" toml:"curlExe"`
	CatExe    string `json:"catExe" toml:"catExe"`
	GitExe    string `json:"gitExe" toml:"gitExe"`
	TarExe    string `json:"tarExe" toml:"tarExe"`
	ScpExe    string `json:"scpExe" toml:"scpExe"`
	SftpExe   string `json:"sftpExe" toml:"sftpExe"`
	UPXExe    string `json:"upxExe" toml:"upxExe"`
	WhichExe  string `json:"whichExe" toml:"whichExe"`
}

type Artifactories

type Artifactories struct {
	Instance []ArtifactoryData `json:"artifactory" toml:"artifactory"`
}

type ArtifactoryData

type ArtifactoryData struct {
	Host      string `json:"host" toml:"host"`
	Path      string `json:"path" toml:"path"`
	Creds     string `json:"creds" toml:"creds"`
	CredsPath string `json:"creds_path" toml:"creds_path"`
	Backup    bool   `json:"backup" toml:"backup"`
}

type BuildData

type BuildData struct {
	Tags       string `json:"tags" toml:"tags"`
	UseAltApps string `json:"useAltApps" toml:"useAltApps"`
}

type Config

type Config struct {
	Build       BuildData     `json:"build"`
	PostClean   PostClean     `json:"postclean"`
	Apps        Apps          `json:"apps"`
	SCP         SCPs          `json:"scp"`
	SFTP        SFTPs         `json:"sftp"`
	SCPCustom   SCPCustoms    `json:"scp-custom"`
	Artifactory Artifactories `json:"artifactory"`
	Project     Projects      `json:"projects"`
}

type GenConfig

type GenConfig struct {
	Build       BuildData         `json:"build" toml:"build" comment:"Build Options"`
	PostClean   PostClean         `json:"postclean" toml:"postclean" comment:"Directories to clean when complete"`
	Apps        Apps              `json:"apps" toml:"apps" comment:"Application paths"`
	SCP         []ScpData         `` /* 138-byte string literal not displayed */
	SFTP        []SftpData        `json:"sftp" toml:"sftp,omitempty" comment:"Array of SFTP Configurations"`
	SCPCustom   []ScpCustom       `json:"scp-custom" toml:"scp-custom,omitempty" comment:"Array of Custom SCP using script"`
	Artifactory []ArtifactoryData `` /* 129-byte string literal not displayed */
	Project     []Project         `json:"project" toml:"project" comment:"Array of projects to build\n- duplicate this section for each project to build"`
}

type PostClean

type PostClean struct {
	Dirs  []string `json:"dirs" toml:"dirs"`
	Files []string `json:"files" toml:"files"`
}

type Project

type Project struct {
	Enable            bool     `json:"-" toml:"-"`
	Name              string   `json:"name" toml:"name"`
	OSTargets         []string `json:"ostargets" toml:"ostargets"`
	OSEnvFlags        []string `json:"os_env_flags" toml:"os_env_flags"`
	OSDeployScripts   []string `json:"osdeployscripts" toml:"osdeployscripts"`
	Package           string   `json:"package" toml:"package"`
	VersionFile       string   `json:"version" toml:"version"`
	ReadmeFile        string   `json:"readme" toml:"readme"`
	ChangelogFile     string   `json:"changelog" toml:"changelog"`
	ChangelogFullFile string   `json:"changelogfull" toml:"changelogfull"`
	Files             []string `json:"files" toml:"files"`
	WindowsFiles      []string `json:"windowsfiles" toml:"windowsfiles"`
	LinuxFiles        []string `json:"linuxfiles" toml:"linuxfiles"`
	MacFiles          []string `json:"macfiles" toml:"macfiles"`
	OverrideVariables string   `` /* 145-byte string literal not displayed */
	OverrideVarFiles  []string `json:"override_var_files" toml:"override_var_files,omitempty" comment:"local files used to fill override variables in order"`
	YNPrompt          string   `json:"ynprompt" toml:"ynprompt,omitempty"`
}

type Projects

type Projects struct {
	Projects []Project `json:"project" toml:"project"`
}

type SCPCustoms

type SCPCustoms struct {
	Instance []ScpCustom `json:"scp-custom" toml:"scp-custom"`
}

type SCPs

type SCPs struct {
	Instance []ScpData `json:"scp" toml:"scp"`
}

type SFTPs

type SFTPs struct {
	Instance []SftpData `json:"sftp" toml:"sftp"`
}

type ScpCustom

type ScpCustom struct {
	Exec string `json:"exec" toml:"exec"`
}

type ScpData

type ScpData struct {
	Host     string `json:"host" toml:"host"`
	Path     string `json:"path" toml:"path"`
	SkipPing string `json:"skip_ping" toml:"skip_ping"`
	Backup   bool   `json:"backup" toml:"backup"`
}

func (*ScpData) UnmarshalJSON

func (s *ScpData) UnmarshalJSON(data []byte) error

type SftpData

type SftpData struct {
	Host     string `json:"host" toml:"host"`
	Path     string `json:"path" toml:"path"`
	SkipPing string `json:"skip_ping" toml:"skip_ping"`
	Backup   bool   `json:"backup" toml:"backup"`
}