build

package module

v0.0.0-...-dda1707 Latest Latest Go to latest Published: Sep 6, 2018 License: MIT Imports: 18 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/bobheadxi/go-build

Links

Open Source Insights

README ¶

🏓 go-build

This is an isolated version of the old build package I wrote for Inertia, a command-line application that enables easy, self-hosted continuous deployment. It provides a Golang API for executing Dockerfile, docker-compose, and Herokuish builds and deployments.

This package is still WIP and in the process of being cleaned up, but the bulk of the code has been in active use in Inertiad for a while - see package inertiad/build.

Documentation ¶

Overview ¶

Package build provides Golang bindings for Docker, docker-compose, and Herokuish builds and deployments. It relies on Docker and some Docker images.

Index ¶

func NewDockerClient() (*docker.Client, error)
type Builder
- func NewBuilder(conf BuilderConfig) *Builder
- func (b *Builder) Build(buildType string, d Config, cli *docker.Client, out io.Writer) (func() error, error)
- func (b *Builder) GetBuildStageName() string
type BuilderConfig
type Config
type LogOptions
type ProjectBuilder

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewDockerClient ¶

func NewDockerClient() (*docker.Client, error)

NewDockerClient creates a new Docker Client from ENV values and negotiates the correct API version

Types ¶

type Builder ¶

type Builder struct {
	// contains filtered or unexported fields
}

Builder manages build tools and executes builds

func NewBuilder ¶

func NewBuilder(conf BuilderConfig) *Builder

NewBuilder creates a builder with given configuration

func (*Builder) Build ¶

func (b *Builder) Build(buildType string, d Config,
	cli *docker.Client, out io.Writer) (func() error, error)

Build executes build and deploy

func (*Builder) GetBuildStageName ¶

func (b *Builder) GetBuildStageName() string

GetBuildStageName returns the name of the intermediary container used to build projects

type BuilderConfig ¶

type BuilderConfig struct {
	DockerComposeVersion string
	HerokuishVersion     string
}

BuilderConfig defines settings for Builder

type Config ¶

type Config struct {
	Name string

	BuildFilePath  string
	BuildDirectory string

	EnvValues []string
}

Config contains parameters required for builds to execute

type LogOptions ¶

type LogOptions struct {
	Container    string
	Stream       bool
	Detailed     bool
	NoTimestamps bool
	Entries      int
}

LogOptions is used to configure retrieved container logs

type ProjectBuilder ¶

type ProjectBuilder func(Config, *docker.Client, io.Writer) (func() error, error)

ProjectBuilder builds projects and returns a callback that can be used to deploy the project. No relation to Bob the Builder, though a Bob did write this.

Source Files ¶

View all Source files

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