Outcome
Production visitors are protected during risky sync steps, and maintenance mode is automatically restored or timed out if something fails.
Maintenance Mode Release Window
Use per-step maintenance mode around risky production workflow steps.
Video walkthrough
▶
Video walkthrough coming soon.
The YouTube embed will appear here.Risk level
High. Maintenance mode protects visitors but does not replace backups or rollback.
Before you start
- Maintenance integration is enabled where supported.
- The timeout is set to a safe value.
- The workflow step labels clearly show when maintenance starts and ends.
Steps
- Enable maintenance integration
Configure the maintenance option and timeout for production. - Apply it only to risky steps
Use it around imports, broad overwrites, or large remote pushes, not harmless dry runs. - Run a dry run without maintenance first
Confirm scope before activating a maintenance window. - Execute in a release window
Run the workflow and monitor Activity until maintenance is cleared. - Confirm restoration
Check that previous maintenance state was restored and timeout cleanup is not pending.
Maintenance mode is not a rollback
It protects visitors while changes happen. You still need backups, conflict strategy, and a restore plan.Code basis
The maintenance helper stores previous state, enables Bricks maintenance mode, schedules a timeout, and clears state when the workflow step completes.
$pathstringRequired
Absolute path of the directory to write the snapshot to.
$modestringOptionaldefault:
two-waySync direction — push, pull or two-way.
$gitboolOptionaldefault:
falseWhen true, commits the snapshot to the repository after writing.