Deployment Workflows

This page covers workflows for deployments and PR checks. For maintenance workflows like backups, refer to Maintenance Workflows.

PR Checks (pr-checks.yml)

Runs on every PR to validate code quality:

1. Validates commit messages using commitlint
2. Validates code formatting using Prettier

Deployments (deploy.yml)

Handles all Vercel deployments:

Production Deployments

• Triggered by push to master
• Deploys to production environment

Preview Deployments

• Automatic for PRs from internal branches
• Manual trigger required for external fork PRs (security measure)
• Deploys to preview environment

Workflow Details

PR Checks Flow

1. PR opened/updated
2. Validates commit messages
3. Validates Prettier formatting

Deployment Flow

1. Triggered by:
   • Push to master → Production deployment
   • Internal PR → Automatic preview deployment
   • External PR → Manual preview deployment (via workflow_dispatch)
2. Builds and deploys to Vercel
3. Notifies GitHub the deployment URL

Security

• External PR deployments require manual trigger by trusted collaborators
• See: https://securitylab.github.com/resources/github-actions-preventing-pwn-requests/

Concurrency

• PR checks: Max one run per PR at all times
• Deployments: Max one deployment per branch/ref at all times
• Both cancel in-progress runs when new commits pushed