grimoire

README

grimoire

a grimoire for my usage of https://github.com/magefile/mage

Documentation

Index

• func Branch() string
• func Hash() string
• func MainDirectoryName() string
• func MainModule() string
• func NormalizePath(name string) string
• func RunIntegrationTest(txt, name string)
• func Tag() string
• type Build
  • func (Build) Binary(packageName, out string) error
• type Ci
  • func (ci Ci) Build() error
  • func (Ci) Validate() error
• type Docker
  • func (Docker) Build() error
• type Go
  • func (Go) Deps() error
  • func (Go) Format() error
  • func (Go) Import() error
  • func (Go) License() error
  • func (Go) Lint() error
  • func (Go) Tidy() error

Functions

func Branch

func Branch() string

Branch returns the git branch for current repo

func Hash

func Hash() string

Hash returns the git hash for the current repo or "" if none.

func MainDirectoryName

func MainDirectoryName() string

MainDirectoryName returns the git main directory name.

func MainModule

func MainModule() string

MainModule returns the main golang module or "" if none.

func NormalizePath

func NormalizePath(name string) string

NormalizePath turns a path into an absolute path and removes symlinks

func RunIntegrationTest

func RunIntegrationTest(txt, name string)

RunIntegrationTest run integration test

func Tag

func Tag() string

Tag returns the git tag for the current branch or "" if none.

Types

type Build

type Build mg.Namespace

Build is a mage namespace which will manage building actions

func (Build) Binary

func (Build) Binary(packageName, out string) error

Binary will trigger the compilation

type Ci

type Ci mg.Namespace

Ci is a mage namespace which will manage continuous integration actions

func (Ci) Build

func (ci Ci) Build() error

Build execute circleci job build on local.

func (Ci) Validate

func (Ci) Validate() error

Validate validate circleci configuration file (circleci/config.yml).

type Docker

type Docker mg.Namespace

Docker is a mage namespace which will manage docker actions

func (Docker) Build

func (Docker) Build() error

Build build a docker image.

type Go

type Go mg.Namespace

Go is a mage namespace which will manage golang actions

func (Go) Deps

func (Go) Deps() error

Deps install dependency tools.

func (Go) Format

func (Go) Format() error

Format runs gofmt on everything

func (Go) Import

func (Go) Import() error

Import runs goimports on everything

func (Go) License

func (Go) License() error

License check that project dont used blacklisted licenses

func (Go) Lint

func (Go) Lint() error

Lint run linter.

func (Go) Tidy

func (Go) Tidy() error

Tidy add/remove depenedencies.