Getting Started

Click the button below to install the GitHub Deploy Freeze app from the GitHub Marketplace.

You'll be redirected to GitHub to authorize the app. You can choose to install it on all repositories or select specific ones.

For each repository where you want to use deployment freezes, you need to add our app as a deployment protection rule.

1. Go to your repository on GitHub
2. Navigate to Settings → Environments
3. Click on an existing environment (e.g., "production") or create a new one
4. Scroll down to Deployment protection rules
5. Click Add deployment protection rule
6. Select GitHub Deploy Freeze from the dropdown
7. Click Save protection rules

You can freeze deployments in two ways:

# .github/workflows/freeze.yml
name: Freeze Production

on:
  workflow_dispatch:

jobs:
  freeze:
    runs-on: ubuntu-latest
    steps:
      - name: Freeze production
        uses: your-org/deploy-freeze-action@v1
        with:
          action: freeze
          environment: production
          reason: "Planned maintenance"
          # Optional: auto-expire after duration
          expires_in: "24h"

Verify that the freeze is working:

1. Freeze an environment using the dashboard or GitHub Actions
2. Try to trigger a deployment to that environment (e.g., via a GitHub Actions workflow)
3. The deployment should be blocked with a message explaining why
4. Unfreeze the environment and try again - it should proceed normally