import * as katoa from "https://deno.land/x/katoa@v0.1.51/mod.ts";

Katoa

Write CI/CD pipelines in TypeScript

Get started with a simple pipeline

import { Job, Pipeline } from "https://deno.land/x/katoa/mod.ts";

const job = new Job({
  name: "Hello World",
  image: "node:18",
  steps: [{
    run: "echo Hello World",
  }],
});

export default new Pipeline([job]);

For more information, see the Katoa documentation.

Classes

c Job	A job is a lightweight container that executes code. Jobs can be configured with JobOptions. By default, all jobs in a pipeline run in parallel.
c Pipeline	A pipeline is an array of jobs. Jobs are executed in parallel by default.
c Secret	A secret is a secure variable, secrets are not cached whereas env variables are.

Interfaces

I CacheDirectoryOptions	Options for a cached directory
I CommonImageOptions
I JobOptions	The options for a job, including the name, base image, environment variables, secrets, folder cache, and steps.
I PipelineOptions	The options for a pipeline, including the name and the conditions under which the pipeline should run.
I ShellOptions	The options to configure a shell
I StepOptions	The options available in a step such as the name, the script to run, what directories to cache, and the secrets/env variables needed.
I TriggerOptions	The options for configuring a pipeline's trigger event.

Type Aliases

T Branch	A git branch represented as a string.
T CacheDirectories	A directory to cache. This is an array of file/folder paths as strings or of CacheDirectoryOptions which allow for further configuration options
T FilePath	A file path represented as a string.
T Shell	The shell to use for running a command. This can be a string or a shell options object.
T Step	A step in the job. A step can either be an object with a run property, a step function (which executed typescript), or a string command (which executes as bash).
T StepFn	A step function that can return void or a number and can be synchronous or asynchronous.
T Trigger	The trigger events which determines when a pipeline should run.