burrow

package

v0.2.0 Latest Latest Go to latest Published: Apr 30, 2018 License: GPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/EmbeddedEnterprises/burrow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package burrow contains all actions that can be executed as subcommands.

Index ¶

func Build(context *cli.Context, useSecondLevelArgs bool) error
func Check(context *cli.Context, useSecondLevelArgs bool) error
func Clean(context *cli.Context) error
func Clone(context *cli.Context) error
func Create(context *cli.Context) error
func Doc(context *cli.Context, useSecondLevelArgs bool) error
func Fetch(context *cli.Context, useSecondLevelArgs bool) error
func Format(context *cli.Context, useSecondLevelArgs bool) error
func Get(context *cli.Context, useSecondLevelArgs bool) error
func Install(context *cli.Context) error
func Major(context *cli.Context) error
func Minor(context *cli.Context) error
func Package(context *cli.Context) error
func Patch(context *cli.Context) error
func Publish(context *cli.Context, useSecondLevelArgs bool) error
func Run(context *cli.Context, useSecondLevelArgs bool) error
func Test(context *cli.Context, useSecondLevelArgs bool) error
func Uninstall(context *cli.Context) error
func Update(context *cli.Context, useSecondLevelArgs bool) error
type ProjectType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(context *cli.Context, useSecondLevelArgs bool) error

Build builds a burrow application to bin/.

func Check ¶

func Check(context *cli.Context, useSecondLevelArgs bool) error

Check checks the code of a burrow project with go vet.

func Clean ¶

func Clean(context *cli.Context) error

Clean cleans a burrow project from any build artifacts.

func Clone ¶

func Clone(context *cli.Context) error

Clone clones a git repository into the GOPATH and creates a symlink in the cwd.

func Create ¶

func Create(context *cli.Context) error

Create creates a new burrow project.

func Doc ¶

func Doc(context *cli.Context, useSecondLevelArgs bool) error

Doc hosts the go documentation on the current machine.

func Fetch ¶

func Fetch(context *cli.Context, useSecondLevelArgs bool) error

Fetch gets all dependencies from the glide lock file for reproducible builds.

func Format ¶

func Format(context *cli.Context, useSecondLevelArgs bool) error

Format formats the code of the current burrow project with gofmt.

func Get ¶

func Get(context *cli.Context, useSecondLevelArgs bool) error

Get installs a dependency in the vendor folder and adds it to the glide yaml.

func Install ¶

func Install(context *cli.Context) error

Install installs the application in the GOPATH.

func Major ¶ added in v0.2.0

func Major(context *cli.Context) error

Major increments the major part of the semantic version in the project configuration.

func Minor ¶ added in v0.2.0

func Minor(context *cli.Context) error

Minor increments the minor part of the semantic version in the project configuration.

func Package ¶

func Package(context *cli.Context) error

Package creates a .tar.gz containing the binary.

func Patch ¶ added in v0.2.0

func Patch(context *cli.Context) error

Patch increments the patch part of the semantic version in the project configuration.

func Publish ¶

func Publish(context *cli.Context, useSecondLevelArgs bool) error

Publish builds the application, packages the application and creates a new version tag in git.

func Run ¶

func Run(context *cli.Context, useSecondLevelArgs bool) error

Run builds and runs the burrow application.

func Test ¶

func Test(context *cli.Context, useSecondLevelArgs bool) error

Test runs all existing tests of the burrow project.

func Uninstall ¶

func Uninstall(context *cli.Context) error

Uninstall uninstalls the burrow application from the GOPATH.

func Update ¶

func Update(context *cli.Context, useSecondLevelArgs bool) error

Update gets all dependencies from the glide yaml file and updates the lock file.

Types ¶

type ProjectType ¶

type ProjectType uint8

The ProjectType describes whether this is a binary or a library project.

const (
	TYPE_BIN ProjectType = iota
	TYPE_LIB
)

The TYPE_... constants describe the type of a project.

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