Recipes / Event-driven

Deploy smoke

A custom DSL run that hits critical URLs after a successful deploy. The GitHub App webhook fires it directly — zero GHA minutes, no workflow file; an Action-mode `ci.yml` is included as the GHA-native alternative.

Fires on After each deploy — wire it any of these ways:

  • Webhook recommended The GitHub App webhook fires the run directly — no .github/workflows file, no GHA minutes. (fires on deployment_status.success)
  • Action A ci.yml step dispatches the run — when it must interleave with other CI jobs or gate the PR.
Use case
Hit critical URLs after a successful deploy
FlareDispatch shape
1 typed run + dispatch
Plain GHA shape
1 workflow · 1 job + REST check-run lifecycle

Source

The recommended FlareDispatch shape is shown first. Toggle to Without FlareDispatch to see the full GitHub Actions workflow a team would maintain to do the same job without it.

Webhook mode — triggered directly by the FlareDispatch GitHub App webhook — zero GHA minutes.
recipes/deploy-smoke/smoke.run.ts
// Recipe: post-deploy smoke test — the `deploy-smoke` Run
//
// Re-exports the canonical run from runs/deploy-smoke.ts (the Dispatcher's
// registered implementation). Copy the runs/deploy-smoke.ts file verbatim
// into your own repo when forking this recipe — the indirection here keeps
// the recipe page in sync with the registered run without duplicating code.
//
// Mode: Webhook mode — fires on `deployment_status.success`, no GHA workflow
//       file. An Action-mode alternative (./ci.yml) dispatches the same run
//       for repos that cannot install the App.
// DSL:  see specs/03-dsl.md.

export { deploySmoke } from "@flare-dispatch/runs/deploy-smoke";