Simp CICD

Even the smallest projects need their CICD tools.

Deployment made easy.

Checkout the official documentation

Warning

Still in active early development stage!...

Send me a message on the discord for every problem you could encounter!

Don't bother beeing polite! We're talking crucial software improvement! I'll do my best to patch the package in the day!

Getting Started

Install

Install the CLI

yarn add -g simpcicd

npm install -g simpcicd

And helpers you need

yarn add -D simpcicd

npm install --save-dev simpcicd

Edit your config file(s) in your project roots

Only ESM config files are supported! See the import/export syntax below.

// simp.config.mjs
// very tiny config file example

import { defineConfig } from "simpcicd";

const localFiles = `.vitepress/dist/*`;
const remoteFoler = `Static/docs.simp.cicd`;

const config = defineConfig({
  pipelines: [
    {
      name: "default",
      steps: [
        {
          name: "build",
          commands: ["yarn", "yarn build"]
        },
        {
          name: "deploy",
          commands: [`rsync -ar ${localFiles} linode:${remoteFoler}`]
        }
      ],
      trigger: {
        branches: ["main", "master", "dev"],
        actions: ["pre-push"]
      }
    }
  ]
});
export default config;

Activate hooks with

simp hooks

Print Logs with

simp logs

The non-verbose "minimal" output looks actually like that. And is likely to change for the better.

More in the documentation...