mixins

Documentation

Overview

mixins page contains magefile targets that perform common tasks that all mixins perform

Index

• type Magefile
  • func NewMagefile(pkg, mixinName, binDir string) Magefile
  • func (m Magefile) Build()
  • func (m Magefile) Clean()
  • func (m Magefile) Install()
  • func (m Magefile) Publish()
  • func (m Magefile) PublishBinaries()
  • func (m Magefile) PublishMixinFeed()
  • func (m Magefile) Test()
  • func (m Magefile) TestPublish(username string)
  • func (m Magefile) TestUnit()
  • func (m Magefile) XBuildAll()

Types

type Magefile

type Magefile struct {
	Pkg       string
	MixinName string
	BinDir    string
}

func NewMagefile

func NewMagefile(pkg, mixinName, binDir string) Magefile

Create a magefile helper for a mixin

func (Magefile) Build

func (m Magefile) Build()

Build the mixin

func (Magefile) Clean

func (m Magefile) Clean()

Remove generated build files

func (Magefile) Install

func (m Magefile) Install()

Install the mixin

func (Magefile) Publish

func (m Magefile) Publish()

Publish the mixin and its mixin feed

func (Magefile) PublishBinaries

func (m Magefile) PublishBinaries()

Publish binaries to a github release Requires PORTER_RELEASE_REPOSITORY to be set to github.com/USERNAME/REPO

func (Magefile) PublishMixinFeed

func (m Magefile) PublishMixinFeed()

Publish a mixin feed Requires PORTER_PACKAGES_REMOTE to be set to git@github.com:USERNAME/REPO.git

func (Magefile) Test

func (m Magefile) Test()

Run all tests

func (Magefile) TestPublish

func (m Magefile) TestPublish(username string)

Test out publish locally, with your github forks Assumes that you forked and kept the repository name unchanged.

func (Magefile) TestUnit

func (m Magefile) TestUnit()

Run unit tests

func (Magefile) XBuildAll

func (m Magefile) XBuildAll()

Cross-compile the mixin before a release