burrow

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2018 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Overview

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

Index

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 when cwd is not in GOPATH.

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 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 New added in v0.3.0

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 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 Project added in v0.3.0

type Project struct {
	Location    string
	Type        ProjectType
	Name        string
	License     string
	Description string
	Authors     []string
}

Project describes all inputs that are needed to create a new project.

func NewProject added in v0.3.0

func NewProject() *Project

NewProject creates a new project from user input from stdin.

func (*Project) Dump added in v0.3.0

func (p *Project) Dump() error

Dump writes all files of a project to the specified location (Project.Location).

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.

Jump to

Keyboard shortcuts

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