Recipe reference
Recipes are the built-in step types a process composes. This reference is generated from
the live catalog, so it always matches the product. The shell recipe is the
universal escape hatch; every recipe's command receives your resolved variables plus
built-ins ($WORKSPACE, $RELEASE_VERSION, $ENVIRONMENT, $TARGET_*).
Apple
| Recipe | Slug | What it does |
|---|---|---|
| Xcode build | xcode-build |
xcodebuild a scheme/configuration (iOS/macOS). Runs on a macOS runner. |
| Xcode test | xcode-test |
xcodebuild test a scheme on a simulator/destination (iOS/macOS). |
| Xcode archive → .ipa | xcode-archive-export |
Archive and export a signed .ipa/.app via xcodebuild + an export options plist. |
| Fastlane lane | fastlane |
Run a fastlane lane (build/sign/upload) on a macOS runner. |
| Notarize (macOS) | notarize |
Submit a build to Apple notary service and wait (xcrun notarytool). |
| Upload to TestFlight | testflight-upload |
Upload an .ipa to App Store Connect / TestFlight (xcrun altool). |
Build
| Recipe | Slug | What it does |
|---|---|---|
| Run a shell command | shell |
Run an arbitrary shell command on the runner. The escape hatch for anything without a dedicated recipe. |
| Gradle build (WAR) | gradle-war |
Run a Gradle task to produce a deployable WAR (the Jak/Payara fleet path). |
| CMake build | cmake-build |
Configure + build a CMake target in Release mode (the Yac/C++ fleet path). |
| Elixir mix release | mix-release |
Assemble an OTP release with mix (the Yax/Elixir fleet path). |
| Save artifact | artifact-save |
Store a build output (versioned, sha256-verified, retained with the release) so a later deploy can restore it instead of rebuilding. Config: name, path (in the workspace). |
| Docker build & push | docker-build-push |
Build a container image and push it to a registry. |
Cache
| Recipe | Slug | What it does |
|---|---|---|
| Restore cache | cache-restore |
Restore a keyed dependency cache (deps/, node_modules/…) into the workspace at the start of a run — later saved by Save cache. |
| Save cache | cache-save |
Save workspace paths into a keyed cache so the next run's Restore cache can reuse them. |
Cloud
| Recipe | Slug | What it does |
|---|---|---|
| kubectl apply | kubectl-apply |
Apply manifests to a cluster (any provider) and optionally wait for a rollout. |
| Helm upgrade/install | helm-deploy |
helm upgrade --install a chart (set image tag/values), waiting for the release to be ready. |
| AWS ECS deploy | aws-ecs-deploy |
Roll an ECS service (force-new-deployment or a new image task-def) and wait for it to stabilize. Creds from a bound Cloud Account. |
| AWS Lambda deploy | aws-lambda-deploy |
Update a Lambda function's code (container image or zip). Creds from a bound Cloud Account. |
| AWS S3 + CloudFront | aws-s3-static |
Sync a static site to S3 and invalidate the CloudFront distribution. |
| GCP Cloud Run deploy | gcp-cloud-run |
gcloud run deploy a container image to Cloud Run. Creds/OIDC from a bound Cloud Account. |
| Azure App Service deploy | azure-webapp |
az webapp deploy an artifact/container to Azure App Service. |
| Azure Functions deploy | azure-functions |
Publish a zip to an Azure Functions app. |
Database
| Recipe | Slug | What it does |
|---|---|---|
| Run dbmate migrations | dbmate-migrate |
Apply pending dbmate migrations against the target database before the app rolls. |
Deploy
| Recipe | Slug | What it does |
|---|---|---|
| Restore artifact | artifact-restore |
Restore a previously-saved artifact of this release into the workspace — build-once-deploy-many and fast rollback. Config: name, path. |
| Deploy over SSH | ssh-deploy |
Copy the artifact to an SSH target and run the install/restart command. Uses hardened SSH (IdentitiesOnly + ControlMaster). |
| Kubernetes apply | k8s-apply |
Apply manifests / set a new image on a Kubernetes deployment and wait for rollout. |
| Kubernetes blue-green | k8s-blue-green |
Deploy the new image as a green copy alongside blue, health-check it, switch the Service selector, then scale blue down (kept for instant rollback). Config: deployment, service, image, health_url (optional), namespace. |
| Kubernetes canary | k8s-canary |
Progressive replica-weighted canary: run the new image as a canary next to stable, step its share up (default 10,50,100%), health-checking between steps; any failed gate tears the canary down and fails the step. Config: deployment, image, steps, health_url, namespace. Publishes ##yakout canary=promoted. |
| Rsync files | rsync-deploy |
Sync a build directory to a target over rsync+ssh. |
| Preview environment teardown | preview-teardown |
Tear down infra for an ephemeral PR preview (namespace, DNS, cloud resources). Also run automatically when a preview env is closed/reaped — add this step so control-plane soft-delete has matching infra cleanup. Config: command (shell; defaults to deleting kubectl namespace ${PREVIEW_SLUG}). |
Gate
| Recipe | Slug | What it does |
|---|---|---|
| Manual approval | approval |
Pause for a human to approve before the process continues (a manual-intervention gate). |
IaC
| Recipe | Slug | What it does |
|---|---|---|
| Terraform apply | terraform-apply |
terraform init + apply -auto-approve (optionally with a var-file). Provider creds from a bound Cloud Account. |
| Pulumi up | pulumi-up |
pulumi up --yes on a stack. |
Notify
| Recipe | Slug | What it does |
|---|---|---|
| Notify Slack | slack-notify |
Post the deployment result to a Slack webhook. |
Source
| Recipe | Slug | What it does |
|---|---|---|
| Checkout source | checkout |
Clone or fast-forward the project repo at a ref, so later steps build from a known commit. |
Test
| Recipe | Slug | What it does |
|---|---|---|
| Run tests | test |
Run a test suite and gate the process on the result. First-class frameworks (ExUnit, Jest, pytest, go test, Gradle, RSpec, cargo, PHPUnit, CTest…) or a custom command; captures JUnit-XML pass/fail counts. |
Verify
| Recipe | Slug | What it does |
|---|---|---|
| HTTP health check | http-health-check |
Poll a URL until it returns a healthy status — the gate that proves the deploy is live. |
Windows
| Recipe | Slug | What it does |
|---|---|---|
| MSBuild | msbuild |
Build a .sln/.csproj with MSBuild (PowerShell). Runs on a Windows runner. |
| .NET CLI | dotnet |
dotnet build/test/publish (PowerShell). Runs on a Windows runner. |
| PowerShell script | powershell |
Run an arbitrary PowerShell script on a Windows runner. |
| IIS deploy | iis-deploy |
Deploy a published site to IIS via Web Deploy / WebAdministration (PowerShell). |