◆ docs

CI / Actions

rickub runs your continuous-integration workflows automatically. Add a workflow file, push, and watch it run.

Add a workflow

Create a YAML file under .github/workflows/ (or .rickub/workflows/) in your repository. On the next push, rickub picks it up and runs it. A minimal workflow:

# .github/workflows/ci.yml
name: CI
on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run tests
        run: |
          make build
          make test

Triggers

The on: key controls when a workflow runs — for example push, pull_request, or a manual, button-triggered workflow_dispatch.

Jobs and steps

A workflow has one or more jobs; each job runs a series of steps. A step either runs a shell command (run:) or uses a reusable action (uses:). Jobs run on a fresh runner each time.

Secrets & variables

Store sensitive values as secrets and non-sensitive configuration as variables, at the repository or organization level, under Settings → Secrets and Settings → Variables. Reference them in a workflow:

steps:
  - name: Deploy
    run: ./deploy.sh
    env:
      API_TOKEN: ${{ secrets.API_TOKEN }}
      REGION: ${{ vars.REGION }}

Heads up

Secrets are write-only once saved and are masked in logs — never echo a secret or print it to the run output.

View runs & logs

Every run appears under the repository's Actions tab. Open a run to see its jobs and steps and to stream the logs live as it executes.

A workflow run showing its status, timing, and jobs arranged by stage — A run: status and timing up top, then its jobs laid out stage by stage. Open a job for its steps and streaming logs.

Re-run & cancel

Re-run a finished run to execute it again at the same commit — handy for flaky failures — and Cancel an in-flight run you no longer need. Both are available from the run page and from the CLI (rickub run rerun, rickub run cancel).

Status badges

Show the latest CI status in your README with a status badge image that links to the Actions tab.

CI-minute quotas

Each plan includes a monthly allowance of CI minutes — the compute time your runs consume. Usage resets every month; the allowance on each plan is listed on the pricing page.

Next steps