vercel rolling-release
The vercel rolling-release command (also available as vercel rr) is used to manage your project's rolling releases. Rolling releases allow you to gradually roll out new deployments to a small fraction of your users before promoting them to everyone.
vercel rolling-release [command]Using vercel rolling-release with a specific command
to manage rolling releases.
Configure rolling release settings for a project.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"manual-approval", "stages":[{"targetPercentage":10},{"targetPercentage":50},{"targetPercentage":100}]}'Using the vercel rolling-release configure command to
set up a rolling release with manual approval stages.
Start a rolling release for a specific deployment.
vercel rolling-release start --dpl=dpl_abc //Where "dpl_abc" is the deployment id or URLUsing the vercel rolling-release start command to
begin a rolling release for a deployment.
Approve the current stage of an active rolling release.
vercel rolling-release approve --dpl=dpl_abc --currentStageIndex=0Using the vercel rolling-release approve command to
approve the current stage and advance to the next stage.
Abort an active rolling release.
vercel rolling-release abort --dpl=dpl_abcUsing the vercel rolling-release abort command to
stop an active rolling release.
Complete an active rolling release, promoting the deployment to 100% of traffic.
vercel rolling-release complete --dpl=dpl_abcUsing the vercel rolling-release complete command to
finish a rolling release and fully promote the deployment.
Fetch details about a rolling release.
vercel rolling-release fetchUsing the vercel rolling-release fetch command to get
information about the current rolling release.
These are options that only apply to the vercel rolling-release command.
The --cfg option is used to configure rolling release settings. It accepts a JSON string or the value 'disable' to turn off rolling releases.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"automatic", "stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":100}]}'Using the vercel rolling-release configure command
with automatic advancement.
The --dpl option specifies the deployment ID or URL for rolling release operations.
vercel rolling-release start --dpl=https://example.vercel.appUsing the vercel rolling-release start command with a
deployment URL.
The --currentStageIndex option specifies the current stage index when approving a rolling release stage.
vercel rolling-release approve --currentStageIndex=0 --dpl=dpl_123Using the vercel rolling-release approve command with
a specific stage index.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"automatic", "stages":[{"targetPercentage":10,"duration":5},{"targetPercentage":100}]}'This configures a rolling release that starts at 10% traffic, automatically advances after 5 minutes, and then goes to 100%.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"manual-approval","stages":[{"targetPercentage":10},{"targetPercentage":100}]}'This configures a rolling release that starts at 10% traffic and requires manual approval to advance to 100%.
vercel rolling-release configure --cfg='{"enabled":true, "advancementType":"manual-approval", "stages":[{"targetPercentage":10},{"targetPercentage":50},{"targetPercentage":100}]}'This configures a rolling release with three stages: 10%, 50%, and 100% traffic, each requiring manual approval.
vercel rolling-release configure --cfg='disable'This disables rolling releases for the project.
The following global options can be passed when using the vercel rolling-release command:
For more information on global options and their usage, refer to the options section.
Was this helpful?