github

type ConveyorImageBuilder ¶ added in v0.10.1

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

ConveyorImageBuilder provides an ImageBuilder implementation that integrates with the Conveyor (https://github.com/remind101/conveyor) Docker build system. If enabled, Empire will check if an Artifact in Conveyor exists for the git commit, and will trigger Conveyor to build it if it doesn't exist.

func NewConveyorImageBuilder(c *conveyor.Service) *ConveyorImageBuilder

func (c *ConveyorImageBuilder) BuildImage(ctx context.Context, w io.Writer, event events.Deployment) (image.Image, error)

type Deployer ¶ added in v0.10.1

type Deployer interface {
	// Deploy performs the deployment, writing output to w. The output
	// written to w should be plain text.
	Deploy(context.Context, events.Deployment, io.Writer) error
}

Deployer represents something that can deploy a github deployment.

func DeployAsync(d Deployer) Deployer

type DeployerFunc ¶ added in v0.10.1

type DeployerFunc func(context.Context, events.Deployment, io.Writer) error

DeployerFunc is a function that implements the Deployer interface.

func (fn DeployerFunc) Deploy(ctx context.Context, event events.Deployment, w io.Writer) error

type DeploymentHandler ¶

type DeploymentHandler struct {
	Deployer
	// contains filtered or unexported fields
}

Deployment is an http.Handler for handling the `deployment` event.

func (h *DeploymentHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type EmpireDeployer ¶ added in v0.10.1

type EmpireDeployer struct {
	ImageBuilder
	// contains filtered or unexported fields
}

EmpireDeployer is a deployer implementation that uses the Deploy method in Empire to perform the deployment.

func NewEmpireDeployer(e *empire.Empire) *EmpireDeployer

func (d *EmpireDeployer) Deploy(ctx context.Context, event events.Deployment, w io.Writer) error

type ImageBuilder ¶ added in v0.10.1

type ImageBuilder interface {
	BuildImage(ctx context.Context, w io.Writer, event events.Deployment) (image.Image, error)
}

ImageBuilder is an interface that represents something that can build and return a Docker image from a GitHub commit. If you need to stream build logs back to the user, you can use the passed in io.Writer and write plain text logs to it.

func ImageFromTemplate(t *template.Template) ImageBuilder

type ImageBuilderFunc ¶ added in v0.10.1

type ImageBuilderFunc func(context.Context, io.Writer, events.Deployment) (image.Image, error)

func (fn ImageBuilderFunc) BuildImage(ctx context.Context, w io.Writer, event events.Deployment) (image.Image, error)

type Options ¶

type Options struct {
	// The GitHub secret to ensure that the request was sent from GitHub.
	Secret string

	// If provided, specifies the environments that this Empire instance
	// should handle deployments for.
	Environments []string

	Deployer Deployer
}

type TugboatDeployer ¶ added in v0.10.1

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

TugboatDeployer is an implementtion of the deployer interface that sends logs and updates the status of the deployment within a Tugboat instance.

func NotifyTugboat(d Deployer, url string) *TugboatDeployer

func (d *TugboatDeployer) Deploy(ctx context.Context, event events.Deployment, out io.Writer) error