Pipelight

Appearance

Common helpers ​

Pipeline definition helpers ​

Pipeline definition helpers are syntaxic sugar for minimalists.

Here, both code blocks do exactly the same thing.

ts
// Without helper
const my_pipeline: Pipeline = {
  name: "example",
  steps: my_steps
};
// Without helper
const my_pipeline: Pipeline = {
  name: "example",
  steps: my_steps
};
ts
// With helper
const my_pipeline = pipeline("example", () => my_steps);
// With helper
const my_pipeline = pipeline("example", () => my_steps);

Use pipeline and step helpers.

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

Use the parallel helper as well.

ts
const my_pipe = pipeline("composition", () => [
  parallel(() => [
    step("do something", () => my_commands),
    step("do something else", () => my_commands)
  ])
]);
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.

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

Step methods ​

Set the Step execution mode.

ts
step("do something", () => my_commands)
  // set the step execution mode
  .set_mode("continue");
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.

ts
ssh(host, () => [...my_commands]);
ssh(host, () => [...my_commands]);
ts
step(
  "do things on remote",
  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.

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

const res = await $`my_command`.text();
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.

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