Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Cronitorex Ping Action

Report GitHub Actions workflow runs to Cronitorex. Built for on: schedule workflows, which fail in a way no workflow badge shows: GitHub can delay or silently skip scheduled runs, and a disabled or broken workflow simply stops running. With a ping at the start and end of the job, Cronitorex alerts you when the workflow stops reporting (a dead man's switch), not just when it fails loudly.

Usage

name: nightly-backup
on:
  schedule:
    - cron: '0 3 * * *'

jobs:
  backup:
    runs-on: ubuntu-latest
    steps:
      - name: Report start
        uses: cronitorex/ping-action@v1
        with:
          monitor: nightly-backup
          api-key: ${{ secrets.CRONITOREX_API_KEY }}
          status: run

      - name: Run the backup
        run: ./scripts/backup.sh

      - name: Report result
        if: always()
        uses: cronitorex/ping-action@v1
        with:
          monitor: nightly-backup
          api-key: ${{ secrets.CRONITOREX_API_KEY }}
          status: auto

status: auto in a step with if: always() maps the job status for you: success becomes complete, cancelled becomes skip, anything else becomes fail. The two steps share a series id derived from the workflow run, so the start and the result are correlated as one execution.

The monitor is created automatically on the first ping (subject to your plan's monitor limit). Set its expected interval and grace period in the Cronitorex panel to match your cron schedule.

Inputs

Input Required Default Description
monitor yes Monitor name ([A-Za-z0-9_-], max 64 chars)
api-key yes Ingest API key (ck_...), keep it in a repository secret
status no auto run, complete, fail, skip or auto
msg no Message, stored as diagnostics when status is fail
duration no Duration in seconds
series no run id + attempt Correlation id for run/complete/fail of one execution
ingest-url no https://api.cronitorex.com Ingest API base URL

Guarantees

  • The action never fails your workflow. Every error path (network down, bad key, rate limit) ends in a warning annotation and exit code 0.
  • The API key is sent in the Authorization header, never in the URL, so it cannot leak into request logs.
  • One HTTP GET with a 10 second cap and two quick retries; no dependencies beyond curl, no Node runtime.

Getting a key

Create a free account at cronitorex.com (15 monitors, no card), copy the ingest key from the panel, and add it to your repository as the CRONITOREX_API_KEY secret.

License

MIT

About

Report scheduled workflow runs to Cronitorex: run/complete/fail pings with a dead man's switch when the workflow stops running.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors