Katoa
Katoa is a community fork of Cidada, a tool created by Fig which was sunset in late 2023 following acquisition by AWS. This fork and the underlying software are both very young, bugs and transitional issues are to be expected.
Katoa: Write CI/CD pipelines in TypeScript, test them locally
Quickstart
Test a pipeline on your local device in < 2 minutes
# Install Katoa
npm install -g @katoahq/katoa
# Set up Katoa in a project
cd path/to/my/project
katoa init
# Test your pipeline locally
katoa run <my-pipeline>
Example
import { Job, Pipeline } from "https://deno.land/x/katoa/mod.ts";
const job = new Job({
name: "My First Job",
image: "ubuntu:22.04",
steps: [
{
name: "Run bash",
run: "echo hello from bash!",
},
{
name: "Run deno/typescript",
run: () => {
console.log("Hello from deno typescript");
},
},
],
});
export default new Pipeline([job]);
Terminology
- Pipeline: Pipelines are TypeScript files like
build.ts,deploy.ts, orrun_tests.ts. They are checked into your repository and run when triggered by an event in your repository, or when triggered manually, or at a defined schedule. A pipeline takes one parameter: an array of jobs. - Jobs: A job is a lightweight container that executes code. It takes one parameter: an array of steps.
- Steps: A step is either a shell script or Deno/TypeScript script that executes in its parent job’s container
3rd party modules (PROBABLY NOT WORKING)
Check out katoahq/modules
Support
👉 Docs: docs
👉 Typescript API: deno.land/x/katoa
👉 Discord: Discord
![[Feature Request] Generate Workflow/Pipeline file(s) for CI/CD providers](https://avatars.githubusercontent.com/u/25773848?v=4)
705 Dec 27, 2022
6 Dec 15, 2022
39 May 7, 2024
15 Jun 17, 2022
22k Jan 3, 2023
5 Nov 3, 2022
4 Oct 31, 2022
7 Dec 16, 2022
2 Oct 12, 2022
18 Dec 29, 2022
22 Sep 3, 2023
6 Nov 12, 2022
0 Feb 4, 2022
7 Dec 30, 2022
0 May 11, 2022
269 Dec 29, 2022
202 Dec 22, 2022
5 Oct 28, 2022
36 Jan 28, 2023