mixins

package

v0.6.4 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getporter/magefiles

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mixins contains magefile targets that perform common tasks that all mixins need to support

Index ¶

type Magefile
- func NewMagefile(pkg, mixinName, binDir string) Magefile

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Magefile ¶

type Magefile struct {
	Pkg       string
	MixinName string
	BinDir    string
}

func NewMagefile ¶

func NewMagefile(pkg, mixinName, binDir string) Magefile

NewMagefile creates a magefile helper for a mixin

func (Magefile) Build ¶

func (m Magefile) Build()

Build the mixin

func (Magefile) Clean ¶

func (m Magefile) Clean()

Clean removes generated build files

func (Magefile) ConfigureAgent ¶ added in v0.3.1

func (m Magefile) ConfigureAgent()

ConfigureAgent sets up a CI worker to use Go and mage.

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()

PublishBinaries uploads cross-compiled 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()

Test runs a full suite of tests

func (Magefile) TestPublish ¶

func (m Magefile) TestPublish(username string)

TestPublish uploads release artifacts to a fork of the mixin's repo. If your mixin is official hosted in a repository under your username, you will need to manually override PORTER_RELEASE_REPOSITORY and PORTER_PACKAGES_REMOTE to test out publishing safely.

func (Magefile) TestUnit ¶

func (m Magefile) TestUnit()

TestUnit runs unit tests

func (Magefile) XBuildAll ¶

func (m Magefile) XBuildAll()

XBuildAll cross-compiles the mixin before a release

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL