The Brigade project is archived. Learn more.

You are viewing docs for Brigade v2. Click here for v1 docs.

Brigade Docs

Examples

Looking for ready-to-run Brigade project examples to use and/or learn from? Check out the Examples directory at the root of the Brigade repo.

Projects

Here are some of the project types you’ll find inside:

  • First Job: A project with an embedded script featuring an event handler that creates and runs a Job
  • Groups: A project with an embedded script featuring organization of multiple Jobs running in sequence and concurrently
  • Git: A project with a script located in its associated Git repository
  • Shared Workspace: A project with an embedded script demonstrating use of a shared workspace between a Worker and its Jobs
  • First Payload: A project with an embedded script demonstrating use of the payload from a handled event

Gateways

The gateways directory currently has an example gateway written using the Go SDK.

For more context and a description of this example gateway, see the Gateways doc.