Skip to main content

Upgrading Cloud Run

EXPERIMENTAL

Cloud Run is in Alpha, which means APIs may change in any version and documentation is not yet finished. See the changelog to stay up to date with breaking changes.

  • Determine the newest version from the Releases page.
  • Upgrade all packages to the newest version (@remotion/cloudrun, but also remotion, @remotion/cli etc.)
- "@remotion/bundler": "4.0.0"
+ "@remotion/bundler": "4.0.1"

- "@remotion/renderer": "4.0.0"
+ "@remotion/renderer": "4.0.1"

- "@remotion/cloudrun": "4.0.0"
+ "@remotion/cloudrun": "4.0.1"

- "remotion": "4.0.0"
+ "remotion": "4.0.1"
  • (Optional): Remove the old versions of the service:
info

You only should do this if the service is not being used anymore. If you are still using it in production, you can just skip this step.

npx remotion cloudrun services rmall -y
npx remotion cloudrun services rmall -y
  • Deploy the newest version of the Remotion Cloud Run service:
npx remotion cloudrun services deploy
npx remotion cloudrun services deploy
  • Update the site:
npx remotion cloudrun sites create src/index.ts --site-name=my-name
npx remotion cloudrun sites create src/index.ts --site-name=my-name
info

Pass --site-name with the name of an existing site to update it. The URL will stay the same but older services may not be able to render the updated site.

If you don't pass --site-name a new site URL will be generated. You'll need to update the serveUrl parameter in your renderMediaOnCloudrun() calls. Old deployed services can still render by specifying the old serve URL.

Separating production and testing environments​

If you already shipped Remotion Cloud Run to production, you can upgrade without incurring any downtime:

  • Each deployed service has a version (see them using npx remotion cloudrun services ls).
    Use the same version of the @remotion/cloudrun package to invoke the function.

  • You can have multiple services with different versions deployed. Use the compatibleOnly parameter to find services that match the version of the @remotion/cloudrun package.

  • Sites/serveUrl's also are version-dependant. Create them with the same version of Remotion that you render them with. Remotion will tolerate mismatches if there are no incompatibilities, but will issue a warning that you might not have all the newest features and bugfixes in the bundled site.