burrow

Documentation

Overview

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

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 Migrate(context *cli.Context) error
• func Minor(context *cli.Context) error
• func New(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

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

func Create

func Create(context *cli.Context) error

Create initializes a directory as a 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 go.mod.

func Install

func Install(context *cli.Context) error

Install installs the application in the GOPATH.

func Major

func Major(context *cli.Context) error

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

func Migrate

func Migrate(context *cli.Context) error

Migrate migrates an old style glide based burrow project to a 'go mod' based one. nolint: gocyclo

func Minor

func Minor(context *cli.Context) error

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

func New

func New(context *cli.Context) error

New creates a new burrow project in the GOPATH.

func Package

func Package(context *cli.Context) error

Package creates a .tar.gz containing the binary.

func Patch

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 go.mod file and updates the go.sum file.