|
| 1 | +# Upgrades |
| 2 | + |
| 3 | +Upgrading a Tobiko Cloud project can be done by going to `Settings > Upgrade`. |
| 4 | +If a new version is available for your project, you'll see an upgrade page like the one below. |
| 5 | +You can choose to upgrade to the latest version or specify a custom version. |
| 6 | +Clicking the **Upgrade Now** button and confirming will start the upgrade process. |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +!!! info "Upgrade Permissions" |
| 11 | + Only users with `Admin` permissions can perform upgrades. |
| 12 | + |
| 13 | +!!! warning "Upgrade Preparations" |
| 14 | + The upgrade process may take a few minutes to complete. During this time, your Tobiko Cloud project will be unavailable. |
| 15 | + Any in-progress plans and runs will be aborted: |
| 16 | + |
| 17 | + - Aborted plans will be stopped and must be recreated. |
| 18 | + - Aborted runs will be automatically resumed shortly after the upgrade completes. |
| 19 | + |
| 20 | + To avoid unexpected interruptions, please notify your team before starting the upgrade. |
| 21 | + |
| 22 | +## Custom Version |
| 23 | + |
| 24 | +Although it is recommended to always upgrade your Tobiko Cloud project to the latest version, |
| 25 | +there may be cases where a team needs to upgrade to a specific version. |
| 26 | + |
| 27 | +For example, a team might have separate staging and production projects. |
| 28 | +They may upgrade the staging project first, run tests, and only upgrade the production project after verifying that staging works as expected. |
| 29 | +If a new version is released during this testing period, the team may want to upgrade production to the same version used in staging. |
| 30 | +Custom version selection supports this workflow. |
| 31 | + |
| 32 | +To specify a custom version, select the **Custom** tab on the Upgrade page and enter the desired version in the text box. |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +!!! info "Valid Custom Version" |
| 37 | + Enter the custom version **without** the leading `v`. |
| 38 | + The version must be valid and greater than the current version of the project. |
| 39 | + If the custom version is not valid, an error message will be displayed. |
| 40 | + |
| 41 | +## Upgrade Progress |
| 42 | + |
| 43 | +After starting the upgrade, a progress page will be shown. |
| 44 | +Once the upgrade is complete, you’ll be automatically redirected back to the upgraded Tobiko Cloud project. |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +## Project Already Up-to-Date |
| 49 | + |
| 50 | +If the project is already on the latest version, you’ll see a message like the one below. |
| 51 | + |
| 52 | + |
0 commit comments