Prompt file imported from AI-Corner/copilot-forge (.github/prompts/forge-canary.prompt.md). Fill in {{IMAGE_PATH}}, {{SHA}} before use. Copyright stays with the author.

canary — Canary Deployment with Smoke Tests

Name: forge-canary
Author: AI-Corner

You are deploying code through a canary process: deploy a zero-traffic revision, verify it works, then promote to live traffic. This prevents broken deploys from reaching users.

Ethos: Follow the principles in .github/copilot-instructions.md throughout this session.

Input

Target: [repo id from .forge/config.yml, Cloud Run service name, or nothing for auto-detection — provided by the user]

Prerequisites

gcloud CLI must be authenticated and configured with the correct project.
The service must already exist on Cloud Run.
A Docker image must be available.

Service Resolution

Service configuration lives in .forge/config.yml under a services: block, keyed by repo id. Read this file via the codebase tool.

Resolution order:

If the argument is a repo id defined under repos: in the config, look up services[<repo-id>].
If the argument is a Cloud Run service name matching services.*.cloud_run_service, use that entry.
If no argument: detect which repo the current workspace is inside by matching against repos[*].path. Then look up its service.
If the project has no .forge/config.yml AND the repo has a top-level Dockerfile, fall back: service name = repo basename, region = us-central1.
If none resolves, stop: "Could not determine Cloud Run service. Add a services: block to .forge/config.yml or pass the service name as an argument."

Instructions

Step 1: Build and Push Image

Run in terminal:

SHA=$(git rev-parse --short HEAD)
IMAGE_PATH=<resolved from config>
docker build -t {{IMAGE_PATH}}:canary-{{SHA}} .
docker push {{IMAGE_PATH}}:canary-{{SHA}}

If the user says "use latest" or the image was built by CI, skip the build and use the :latest tag.

Step 2: Deploy Canary Revision (Zero Traffic)

gcloud run deploy <SERVICE_NAME> \
  --image=<IMAGE_PATH>:canary-<SHA> \
  --region=<region from config> \
  --no-traffic \
  --tag=canary \
  --format="json"

Capture the canary URL from the output (the tagged revision URL).

Step 3: Health Checks

# Retry up to 3 times with 5-second intervals (cold start grace period)
curl -s -o /dev/null -w "%{http_code}" <CANARY_URL>/health
curl -s -o /dev/null -w "%{http_code}" <CANARY_URL>/api/health

Expected: 200. If health checks fail after 3 retries, go to Step 6 (Rollback).

Step 4: Smoke Tests

Read .forge/context/smoke-tests.md if it exists for custom test definitions. Otherwise use defaults:

GET  /health      -> 200
GET  /api/health  -> 200

For each test:

RESPONSE=$(curl -s -w "\n%{http_code}" <CANARY_URL><PATH>)
STATUS=$(echo "$RESPONSE" | tail -1)

Report results:

## Smoke Test Results

| Test | Method | Path | Expected | Actual | Status |
|------|--------|------|----------|--------|--------|
| Health | GET | /health | 200 | 200 | PASS |

Result: 2/2 passed

If any test fails, go to Step 6 (Rollback).

Step 5: Promote to Production

gcloud run services update-traffic <SERVICE_NAME> \
  --region=<region> \
  --to-tags=canary=100

# Verify
gcloud run services describe <SERVICE_NAME> \
  --region=<region> \
  --format="table(status.traffic[].percent,status.traffic[].revisionName)"

# Clean up canary tag
gcloud run services update-traffic <SERVICE_NAME> \
  --region=<region> \
  --remove-tags=canary

Report:

Canary promoted to production.
Service: <SERVICE_NAME>
Revision: <REVISION_NAME>
All smoke tests passed.

Step 6: Rollback (Failure Path)

gcloud run services update-traffic <SERVICE_NAME> \
  --region=<region> \
  --remove-tags=canary

Report:

CANARY FAILED — rolled back.
Service: <SERVICE_NAME>
Failed revision: canary-<SHA>
Failures: [list failed checks]
Production traffic is unchanged.

Suggest: gcloud run services logs read <SERVICE_NAME> --region=<region> --limit=50

Step 7: Update Pipeline State (if in #forge-proceed context)

If pipeline-state.json exists for the current REQ, add a canary entry to phaseHistory with the result (passed/failed), service name, revision, and smoke test results.

Internal Reference

Incoming Skill Dependencies: #forge-proceed, #forge-bugfix
Incoming Agent Dependencies: None
Outgoing Skill Dependencies: None
Outgoing Agent Dependencies: None
Resource Dependencies: None

# canary — Canary Deployment with Smoke Tests You are deploying code through a canary process: deploy a zero-traffic revision, verify it works, then promote to live traffic. This prevents broken deploys from reaching users. > **Ethos**: Follow the principles in `.github/copilot-instructions.md` throughout this session. ## Input Target: [repo id from `.forge/config.yml`, Cloud Run service name, or nothing for auto-detection — provided by the user] ## Prerequisites 1. `gcloud` CLI must be authenticated and configured with the correct project. 2. The service must already exist on Cloud Run. 3. A Docker image must be available. ## Service Resolution Service configuration lives in `.forge/config.yml` under a `services:` block, keyed by repo id. Read this file via the codebase tool. **Resolution order**: 1. If the argument is a repo id defined under `repos:` in the config, look up `services[<repo-id>]`. 2. If the argument is a Cloud Run service name matching `services.*.cloud_run_service`, use that entry. 3. If no argument: detect which repo the current workspace is inside by matching against `repos[*].path`. Then look up its service. 4. If the project has no `.forge/config.yml` AND the repo has a top-level `Dockerfile`, fall back: service name = repo basename, region = `us-central1`. 5. If none resolves, stop: "Could not determine Cloud Run service. Add a `services:` block to `.forge/config.yml` or pass the service name as an argument." ## Instructions ### Step 1: Build and Push Image Run in terminal: ```bash SHA=$(git rev-parse --short HEAD) IMAGE_PATH=<resolved from config> docker build -t {{IMAGE_PATH}}:canary-{{SHA}} . docker push {{IMAGE_PATH}}:canary-{{SHA}} ``` If the user says "use latest" or the image was built by CI, skip the build and use the `:latest` tag. ### Step 2: Deploy Canary Revision (Zero Traffic) ```bash gcloud run deploy <SERVICE_NAME> \ --image=<IMAGE_PATH>:canary-<SHA> \ --region=<region from config> \ --no-traffic \ --tag=canary \ --format="json" ``` Capture the canary URL from the output (the tagged revision URL). ### Step 3: Health Checks ```bash # Retry up to 3 times with 5-second intervals (cold start grace period) curl -s -o /dev/null -w "%{http_code}" <CANARY_URL>/health curl -s -o /dev/null -w "%{http_code}" <CANARY_URL>/api/health ``` Expected: `200`. If health checks fail after 3 retries, go to Step 6 (Rollback). ### Step 4: Smoke Tests Read `.forge/context/smoke-tests.md` if it exists for custom test definitions. Otherwise use defaults: ``` GET /health -> 200 GET /api/health -> 200 ``` For each test: ```bash RESPONSE=$(curl -s -w "\n%{http_code}" <CANARY_URL><PATH>) STATUS=$(echo "$RESPONSE" | tail -1) ``` Report results: ``` ## Smoke Test Results | Test | Method | Path | Expected | Actual | Status | |------|--------|------|----------|--------|--------| | Health | GET | /health | 200 | 200 | PASS | Result: 2/2 passed ``` If any test fails, go to Step 6 (Rollback). ### Step 5: Promote to Production ```bash gcloud run services update-traffic <SERVICE_NAME> \ --region=<region> \ --to-tags=canary=100 # Verify gcloud run services describe <SERVICE_NAME> \ --region=<region> \ --format="table(status.traffic[].percent,status.traffic[].revisionName)" # Clean up canary tag gcloud run services update-traffic <SERVICE_NAME> \ --region=<region> \ --remove-tags=canary ``` Report: ``` Canary promoted to production. Service: <SERVICE_NAME> Revision: <REVISION_NAME> All smoke tests passed. ``` ### Step 6: Rollback (Failure Path) ```bash gcloud run services update-traffic <SERVICE_NAME> \ --region=<region> \ --remove-tags=canary ``` Report: ``` CANARY FAILED — rolled back. Service: <SERVICE_NAME> Failed revision: canary-<SHA> Failures: [list failed checks] Production traffic is unchanged. ``` Suggest: `gcloud run services logs read <SERVICE_NAME> --region=<region> --limit=50` ### Step 7: Update Pipeline State (if in #forge-proceed context) If `pipeline-state.json` exists for the current REQ, add a `canary` entry to `phaseHistory` with the result (passed/failed), service name, revision, and smoke test results. ## Internal Reference - **Incoming Skill Dependencies**: `#forge-proceed`, `#forge-bugfix` - **Incoming Agent Dependencies**: *None* - **Outgoing Skill Dependencies**: *None* - **Outgoing Agent Dependencies**: *None* - **Resource Dependencies**: *None*

{ "prompt": "# canary — Canary Deployment with Smoke Tests\n\nYou are deploying code through a canary process: deploy a zero-traffic revision, verify it works, then promote to live traffic. This prevents broken deploys from reaching users.\n\n> **Ethos**: Follow the principles in `.github/copilot-instructions.md` throughout this session.\n\n## Input\n\nTarget: [repo id from `.forge/config.yml`, Cloud Run service name, or nothing for auto-detection — provided by the user]\n\n## Prerequisites\n\n1. `gcloud` CLI must be authenticated and configured with the correct project.\n2. The service must already exist on Cloud Run.\n3. A Docker image must be available.\n\n## Service Resolution\n\nService configuration lives in `.forge/config.yml` under a `services:` block, keyed by repo id. Read this file via the codebase tool.\n\n**Resolution order**:\n1. If the argument is a repo id defined under `repos:` in the config, look up `services[<repo-id>]`.\n2. If the argument is a Cloud Run service name matching `services.*.cloud_run_service`, use that entry.\n3. If no argument: detect which repo the current workspace is inside by matching against `repos[*].path`. Then look up its service.\n4. If the project has no `.forge/config.yml` AND the repo has a top-level `Dockerfile`, fall back: service name = repo basename, region = `us-central1`.\n5. If none resolves, stop: \"Could not determine Cloud Run service. Add a `services:` block to `.forge/config.yml` or pass the service name as an argument.\"\n\n## Instructions\n\n### Step 1: Build and Push Image\nRun in terminal:\n```bash\nSHA=$(git rev-parse --short HEAD)\nIMAGE_PATH=<resolved from config>\ndocker build -t {{IMAGE_PATH}}:canary-{{SHA}} .\ndocker push {{IMAGE_PATH}}:canary-{{SHA}}\n```\nIf the user says \"use latest\" or the image was built by CI, skip the build and use the `:latest` tag.\n\n### Step 2: Deploy Canary Revision (Zero Traffic)\n```bash\ngcloud run deploy <SERVICE_NAME> \\\n --image=<IMAGE_PATH>:canary-<SHA> \\\n --region=<region from config> \\\n --no-traffic \\\n --tag=canary \\\n --format=\"json\"\n```\nCapture the canary URL from the output (the tagged revision URL).\n\n### Step 3: Health Checks\n```bash\n# Retry up to 3 times with 5-second intervals (cold start grace period)\ncurl -s -o /dev/null -w \"%{http_code}\" <CANARY_URL>/health\ncurl -s -o /dev/null -w \"%{http_code}\" <CANARY_URL>/api/health\n```\nExpected: `200`. If health checks fail after 3 retries, go to Step 6 (Rollback).\n\n### Step 4: Smoke Tests\nRead `.forge/context/smoke-tests.md` if it exists for custom test definitions. Otherwise use defaults:\n```\nGET /health -> 200\nGET /api/health -> 200\n```\n\nFor each test:\n```bash\nRESPONSE=$(curl -s -w \"\\n%{http_code}\" <CANARY_URL><PATH>)\nSTATUS=$(echo \"$RESPONSE\" | tail -1)\n```\n\nReport results:\n```\n## Smoke Test Results\n\n| Test | Method | Path | Expected | Actual | Status |\n|------|--------|------|----------|--------|--------|\n| Health | GET | /health | 200 | 200 | PASS |\n\nResult: 2/2 passed\n```\nIf any test fails, go to Step 6 (Rollback).\n\n### Step 5: Promote to Production\n```bash\ngcloud run services update-traffic <SERVICE_NAME> \\\n --region=<region> \\\n --to-tags=canary=100\n\n# Verify\ngcloud run services describe <SERVICE_NAME> \\\n --region=<region> \\\n --format=\"table(status.traffic[].percent,status.traffic[].revisionName)\"\n\n# Clean up canary tag\ngcloud run services update-traffic <SERVICE_NAME> \\\n --region=<region> \\\n --remove-tags=canary\n```\n\nReport:\n```\nCanary promoted to production.\nService: <SERVICE_NAME>\nRevision: <REVISION_NAME>\nAll smoke tests passed.\n```\n\n### Step 6: Rollback (Failure Path)\n```bash\ngcloud run services update-traffic <SERVICE_NAME> \\\n --region=<region> \\\n --remove-tags=canary\n```\nReport:\n```\nCANARY FAILED — rolled back.\nService: <SERVICE_NAME>\nFailed revision: canary-<SHA>\nFailures: [list failed checks]\nProduction traffic is unchanged.\n```\nSuggest: `gcloud run services logs read <SERVICE_NAME> --region=<region> --limit=50`\n\n### Step 7: Update Pipeline State (if in #forge-proceed context)\nIf `pipeline-state.json` exists for the current REQ, add a `canary` entry to `phaseHistory` with the result (passed/failed), service name, revision, and smoke test results.\n\n## Internal Reference\n- **Incoming Skill Dependencies**: `#forge-proceed`, `#forge-bugfix`\n- **Incoming Agent Dependencies**: *None*\n- **Outgoing Skill Dependencies**: *None*\n- **Outgoing Agent Dependencies**: *None*\n- **Resource Dependencies**: *None*", "variables": [ "IMAGE_PATH", "SHA" ], "notes": "Canary deployment — deploy a zero-traffic revision, run smoke tests, promote on success Tools: codebase, runCommand, changes, terminalLastCommand.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/AI-Corner/copilot-forge", "path": ".github/prompts/forge-canary.prompt.md", "ref": "11c57fac702a4047926276fade2f26953ac9b23c", "url": "https://github.com/AI-Corner/copilot-forge/blob/11c57fac702a4047926276fade2f26953ac9b23c/.github/prompts/forge-canary.prompt.md", "key": "AI-Corner/copilot-forge/.github/prompts/forge-canary.prompt.md" } } }

forge-canary

About