Skip to main content

release-api

Review Anarlog API contracts and generated clients, deploy required hosted services and database changes, and verify live release behavior.

Informations de source

Dépôt
fastrepl/anarlog
Dernière activité de la source
20 septembre 2026 à 23:59
Langue détectée de SKILL.md
anglais
Étoiles
9 873
Forks
839

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
release-api
description
Review Anarlog API contracts and generated clients, deploy required hosted services and database changes, and verify live release behavior.
metadata
{"internal":true}
# Release API Review every release, including client-only changes. Inherit scope and session authorization from [Release a New Version](../release-new-version/SKILL.md). 1. Compare changed product behavior and each service's live source SHA against `apps/api`, `apps/stripe`, `crates/api-cloud`, affected auth/sync/proxy crates, `supabase/`, `apps/api/openapi.gen.json`, and `packages/api-client/src/generated`. Check auth, scopes, payloads/errors, pagination, data compatibility, and existing client behavior. Record required changes, concrete reuse reasons, or explicit deferrals before freezing the candidate. 2. Read `api_ci.yaml`, `api_cd.yaml`, `db_ci.yaml`, and `db_cd.yaml` plus the affected component instructions. Run the full locally reproducible affected jobs and consumer checks. For contract changes, run: ```bash cargo test -p api gen_openapi_json pnpm -F @anlg/api-client openapi pnpm -F @anlg/api-client typecheck ``` Use owning generators and verify repeated generation is stable. Test hosted migrations/RLS in an isolated local Supabase stack, never against production. 3. Inspect current service choices and live configuration before deploying. Core, AI, Sync, Gateway, and billing have independent deployment decisions. The billing API and `apps/stripe` ship together via `api_cd.yaml` with `service=billing`. Do not treat a shared API version/tag as proof every service runs that source. Hosted Postgres has its own `db_cd.yaml` deployment history. 4. Deploy required backward-compatible hosted changes before dependent desktop or mobile clients. Select the exact approved environment, service and merged source. Use `gh workflow run api_cd.yaml --ref main -f service=<service>` and `gh workflow run db_cd.yaml --ref main` as appropriate, after reading their current inputs. Verify each run's `headSha`; never ship the combined GitButler workspace. Include every dependency in filtered Docker build contexts. 5. Follow deployments to terminal success. Confirm actual serving source/digest, version and role-specific readiness, then exercise affected authenticated behavior with an authorized test account. `/health`, an unauthenticated `401`, or one healthy role does not prove other roles or operations work. Coordinate hosted protocol checks with [Release MCP](../release-mcp/SKILL.md). 6. For schema changes, record the selected hosted project, applied migrations, source/run and compatibility checks. Keep shipped SQLite migrations append-only, desktop/mobile schemas compatible, and older clients supported. Follow current drain, migration, continuity, and recovery requirements; successful health checks alone do not establish zero downtime. Return generated-contract decisions, candidate CI, each service/database's deployed revision and run URL, live evidence, or reuse reason and outstanding work. Reuse a live deployment only when its source includes the required changes; no artificial version bumps or no-op redeploys. Website and Mintlify publication belong to [Release Docs](../release-docs/SKILL.md), not the API deploy.
Voir sur GitHub