Skip to main content

Update a Private Bench

Private Bench updates allow you to install the latest versions of your apps while giving you complete control over which apps are updated. You can monitor the deployment process, view deployed versions, and even automate deployments using commit markers.

Note

Bench updates are available only for Private Benches. Public Bench updates are managed automatically by Frappe Cloud.

Update a Bench

  1. Open your Private Bench dashboard.
  2. If updates are available, an Update Available banner will appear.
  3. Click Show Updates.
  4. Select the apps you want to update. You can leave apps unchecked if you don’t want to update them.
  5. Click Deploy to begin the update.

Important

If you update ERPNext, the Frappe Framework update cannot be deselected because ERPNext depends on the matching Frappe version.

Monitor Deployment Progress

You can track the deployment from the Deploys tab.

Select a deployment to view its progress and each stage of the deployment process.

While a deployment is running, a Fail Build button is available if you need to cancel the build before it completes.

Bench Provisioning Queue

After the build completes successfully, your bench enters the provisioning stage.

If server resources are currently busy, you’ll see a Benches In Queue status.

This simply means your bench is waiting for an available provisioning slot. Once resources become available, the deployment starts automatically without requiring any action from you.

View Deployed App Versions

After deployment:

  1. Open the deployment from the Deploys tab.
  2. Click the three-dot (⋮) menu.
  3. Select View App Versions.

A dialog displays every deployed app along with its version.

Redeploy a Bench

The Redeploy option is available when a deployment has either:

  • Succeeded
  • Failed

Redeploy creates a new deployment using the same app versions. This is useful if the deployment was affected by temporary issues such as:

  • Server connectivity problems
  • Insufficient disk space
  • Temporary deployment failures

Automatic Bench Deployment Using Commit Markers

You can automatically deploy benches whenever you push changes to your repository.

Deploy All Eligible Benches

Add the press-deploy marker anywhere in your commit message.

Added new changes to custom app press-deploy

This automatically deploys every eligible bench owned by your team where the app is installed and the bench has the auto-deploy tag.

Deploy a Specific Bench

To deploy only one bench, include its identifier in the commit message.

Added new changes to custom app press-deploy-bench-10202

This deploys only the specified bench.

When Auto Deployment Will Not Run

Automatic deployment is skipped if:

  • The bench is not owned by your team.
  • The bench is disabled.
  • A deployment is already running for that bench.

Yanked App Releases

Sometimes an app release may be marked as Yanked. Yanked releases are withdrawn and should not be installed.

If you see a warning during an update indicating that a release has been yanked, simply choose a valid non-yanked release before deploying again.

Good to Know

Once the bench has been updated, sites with Auto Update enabled are automatically updated during the maintenance window between 1:00 AM and 4:00 AM.

Rating: 0 / 5 (0 votes)