github

Documentation

Overview

Package github provides an http.Handler implementation that allows Empire to handle GitHub Deployments.

Index

• Variables
• func New(e *empire.Empire, opts Options) http.Handler
• func Ping(w http.ResponseWriter, r *http.Request)
• type ConveyorImageBuilder
  • func NewConveyorImageBuilder(c *conveyor.Service) *ConveyorImageBuilder
  • func (c *ConveyorImageBuilder) BuildImage(ctx context.Context, w io.Writer, event events.Deployment) (image.Image, error)
• type Deployer
  • func DeployAsync(d Deployer) Deployer
• type DeployerFunc
  • func (fn DeployerFunc) Deploy(ctx context.Context, event events.Deployment, w io.Writer) error
• type DeploymentHandler
  • func (h *DeploymentHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type EmpireDeployer
  • func NewEmpireDeployer(e *empire.Empire) *EmpireDeployer
  • func (d *EmpireDeployer) Deploy(ctx context.Context, event events.Deployment, w io.Writer) error
• type ImageBuilder
  • func ImageFromTemplate(t *template.Template) ImageBuilder
• type ImageBuilderFunc
  • func (fn ImageBuilderFunc) BuildImage(ctx context.Context, w io.Writer, event events.Deployment) (image.Image, error)
• type Options
• type TugboatDeployer
  • func NotifyTugboat(d Deployer, url string) *TugboatDeployer
  • func (d *TugboatDeployer) Deploy(ctx context.Context, event events.Deployment, out io.Writer) error

Variables

var (
	// DefaultTemplate is a text/template string that will be used to map a
	// deployment event to a docker image to deploy.
	DefaultTemplate = `{{ .Repository.FullName }}:{{ .Deployment.Sha }}`
)

Functions

func New

func New(e *empire.Empire, opts Options) http.Handler

func Ping

func Ping(w http.ResponseWriter, r *http.Request)

Types

type ConveyorImageBuilder

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

func NewConveyorImageBuilder(c *conveyor.Service) *ConveyorImageBuilder

NewConveyorImageBuilder returns a new ConveyorImageBuilder implementation that uses the given client.

func (*ConveyorImageBuilder) BuildImage

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

type Deployer

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

func DeployAsync(d Deployer) Deployer

DeployAsync wraps a Deployer to perform the Deploy within a goroutine.

type DeployerFunc

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

DeployerFunc is a function that implements the Deployer interface.

func (DeployerFunc) Deploy

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 (*DeploymentHandler) ServeHTTP

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

type EmpireDeployer

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

func NewEmpireDeployer(e *empire.Empire) *EmpireDeployer

NewEmpireDeployer returns a new EmpireDeployer instance.

func (*EmpireDeployer) Deploy

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

Deploy builds/determines the docker image to deploy, then deploys it with Empire.

type ImageBuilder

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

func ImageFromTemplate(t *template.Template) ImageBuilder

ImageFromTemplate returns an ImageBuilder that will execute a template to determine what docker image should be deployed. Note that this doesn't not actually perform any "build".

type ImageBuilderFunc

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

func (ImageBuilderFunc) BuildImage

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

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

func NotifyTugboat(d Deployer, url string) *TugboatDeployer

NotifyTugboat wraps a Deployer to sent deployment logs and status updates to a Tugboat instance.

func (*TugboatDeployer) Deploy

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