Getting started / Introduction

Getting started

Introduction

Cronkick triggers your GitHub Actions workflows on schedule, on your own runners.

GitHub’s schedule: trigger is best-effort: at busy times runs start late, and some never start. Cronkick replaces it. It triggers your workflow through workflow_dispatch at the scheduled time, so the job still runs on your runners, with your secrets, exactly as before.

How it works

  1. You install the Cronkick GitHub App on the repositories you choose.
  2. In a workflow file, you add workflow_dispatch: and a comment like # cronkick: "0 3 * * *".
  3. When you push, Cronkick reads the comment. At each scheduled time it asks GitHub to start the workflow, aiming for within 30 seconds.
  4. Your dashboard records each planned run: when it was due, when Cronkick sent it, when GitHub started the run, and the result. If Cronkick itself is down, the gap is shown as an outage window.

Next steps