Common helpers

Pipeline definition helpers

Pipeline definition helpers are syntaxic sugar for minimalists.

Here, both code blocks do exactly the same thing.

// Without helper
const my_pipeline: Pipeline = {
  name: "example",
  steps: my_steps
};

// With helper
const my_pipeline = pipeline("example", () => my_steps);

Use pipeline and step helpers.

const my_pipe = pipeline("composition", () => [
  step("do something", () => my_commands),
  step("do something else", () => my_commands)
]);

Use the parallel helper as well.

const my_pipe = pipeline("composition", () => [
  parallel(() => [
    step("do something", () => my_commands),
    step("do something else", () => my_commands)
  ])
]);

Pipeline methods

Add a trigger to the Pipeline.

const my_pipe = pipeline("composition", () => [
  step("do something", () => my_commands)
])
  // add a trigger
  .add_trigger({
    branches: [],
    actions: []
  });

Step methods

Set the Step execution mode.

step("do something", () => my_commands)
  // set the step execution mode
  .set_mode("continue");

Remote operations helper

For when you execute commands on remote servers.

Instead of prefixing every command with ssh -C like you will normaly do in bash, the ssh helper wrap them for you.

ssh(host, () => [...my_commands]);

step(
  "do things on remote",
  ssh(host, () => [...my_commands])
);

Early execution helper

When you need to retrieve data before your pipeline execution. The helper has been replace with the DAX module allowing more customisation and type safety.

import $ from "https://deno.land/x/dax/mod.ts";

const res = await $`my_command`.text();

Can be used to retrieve git infos, like your latest tag and use it in your pipeline declaration.

const version = await $`git describe --tags --abbrev=0`.text()
// version = "v0.10.0-any"