Skip to main content

Deployment & Release

The service deploys to Cloud Run through GitHub Actions. Staging deploys on every merge; production deploys when a release is tagged.

EnvironmentTriggerWorkflow
StagingMerge to mainBuild and Deploy Staging
ProductionA vX.Y.Z tag is pushedBuild and Deploy Production

Changes to markdown files alone don't trigger a staging deploy.

Every pull request and every deploy runs Biome, the type check and the tests first. A failure stops the deploy.

Releasing to production​

  1. In GitHub Actions, run 🏷️ Tag new release on main and pick Patch, Minor or Major.
  2. The workflow creates the next version tag and a GitHub release.
  3. The tag starts Build and Deploy Production, which also writes the release notes.

Configuration​

The deploy only sets a few variables. Credentials and other settings live on the Cloud Run service itself, so a new variable has to be added there by hand in each project.

Monitoring​

Production has four alert policies in Cloud Monitoring:

  • Catalog API uptime failure
  • Catalog API 5xx errors
  • Catalog API authorizer failures
  • Catalog API serving stale taxonomy

Staging has no alerts.