Scheduling Freezes
Temporarily block merging during maintenance, release, or blackout windows.
When to Use a Freeze
Section titled When to Use a FreezeUse freezes to coordinate:
- Critical release stabilization
- High-traffic events where deploy risk must be minimized
- End-of-quarter / audit windows
- Incident response (manual immediate freeze)
Creating a Scheduled Freeze
Section titled Creating a Scheduled Freeze
In the dashboard under Merge Protections → Freezes:
-
Click
Schedule a Freeze -
Define start / end (UTC)
-
Add matching conditions: by default the freeze applies to every pull requests, but you can limit its impact with this field
-
Save; active freezes appear in the list
During a freeze, the protection check fails with a clear message unless an override condition is met (see below).
Manual Instant Freeze
Section titled Manual Instant FreezeUse the Freeze Merges Now action for immediate blocking. You can later
unfreeze manually.
Allowing Exceptions
Section titled Allowing ExceptionsCreate a rule with a success condition that grants override, e.g.:
- label != hotfixThen apply the hotfix label (manually or via automation) to bypass the freeze
for a specific PR.
Managing Freezes with the CLI
Section titled Managing Freezes with the CLIYou can also manage freezes from the command line using the Mergify CLI.
Listing Freezes
Section titled Listing FreezesList all scheduled freezes for a repository:
mergify freeze listUse --json to get machine-readable output:
mergify freeze list --jsonCreating a Freeze
Section titled Creating a FreezeCreate a time-bounded freeze:
mergify freeze create \ --reason "Release stabilization" \ --timezone UTC \ --start 2024-01-15T18:00:00 \ --end 2024-01-15T22:00:00Create an emergency freeze with no end time:
mergify freeze create \ --reason "Incident response" \ --timezone UTCYou can restrict which pull requests are affected using conditions and exclusions:
mergify freeze create \ --reason "Freeze main branch" \ --timezone UTC \ -c "base=main" \ -e "label=hotfix"Updating a Freeze
Section titled Updating a FreezeModify an existing freeze by its ID:
mergify freeze update <freeze_id> \ --end 2024-01-16T06:00:00Deleting a Freeze
Section titled Deleting a FreezeRemove a freeze by its ID:
mergify freeze delete <freeze_id>Was this page helpful?
Thanks for your feedback!