Giter VIP home page Giter VIP logo

cicada's Introduction

Important

Cicada is archived and will no longer be maintained. Thank you for your contributions and support.

Cicada

Cicada: Write CI/CD pipelines in TypeScript, test them locally

Quickstart

Test a pipeline on your local device in < 2 minutes

# Install Cicada
npm install -g @cicadahq/cicada 

# Set up Cicada in a project
cd path/to/my/project
cicada init

# Test your pipeline locally
cicada run <my-pipeline>

Deploy your pipeline to our cloud so it runs on every PR/commit:

  1. Sign up at cicada.build/dashboard
  2. Link your repository using our GitHub integration
  3. Push your pipeline to GitHub

Example

import { Job, Pipeline } from "https://deno.land/x/cicada/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, or run_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

Check out cicadahq/modules

Support

๐Ÿ‘‰ Docs: cicada.build/docs

๐Ÿ‘‰ Typescript API: deno.land/x/cicada

๐Ÿ‘‰ Discord: cicada.build/discord

Enterprise

Need self-hosted runners, advanced security and compliance, custom integrations, or something else? We can help!

Please email [email protected]

cicada's People

Contributors

brendanfalk avatar chaynabors avatar cstrnt avatar dependabot[bot] avatar fedeci avatar grant0417 avatar mschrage avatar nawok avatar v1re avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.