Awesome

⚠️  This repo contains the source for Brigadier v1.x, which is compatible with Brigade v1.x. Brigade v1.x reached end-of-life on June 1, 2022. Brigadier lives on as a Brigade v2.x-compatible library. Please refer to the main Brigade repository to find the latest Brigadier source code.

Brigadier: The JS library for Brigade

Brigadier is the events and jobs library for Brigade.

This is the core of the Brigadier library, but the Kubernetes runtime is part of Brigade itself. To run a brigade.js file in Kubernetes, it will need to be executed within Brigade.

What is it good for?

This library is useful for:

• testing brigade.js files
• extending Brigade's worker
• supporting code completion in tooling
• implementing alternative Brigade backends

Because there is no JobRunner implementation, executing job.run() is a no-op unless you override the appropriate methods on the Job class.

Installation

Install with Yarn, NPM, etc.:

$ yarn add @brigadecore/brigadier

While this library is fairly stable, it is considered best to match the version of this library to the version of Brigade that you are using.

Usage

The API is the same here as in Brigade's API:

const {events, Job} = require("@brigadecore/brigadier");

events.on("push", (e, p) => {
    console.log("Got a push event");
    const j = new Job("example", "alpine:3.7");
    j.run().then((res) => {
        console.log(`result: ${ res.toString() } `)
    });
});

To learn more, visit the official scripting guide.

Contributing

This Brigade project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.

Signed commits

A DCO sign-off is required for contributions to repos in the brigadecore org. See the documentation in Brigade's Contributing guide for how this is done.