Skip to content

Commit a8d7a5e

Browse files
docs: review serverless functions upgrade instructions
Signed-off-by: David Dal Busco <david.dalbusco@outlook.com>
1 parent 3aa1a70 commit a8d7a5e

3 files changed

Lines changed: 33 additions & 6 deletions

File tree

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:::danger[Important]
2+
3+
If your Satellite includes custom serverless functions, **do not upgrade through the Juno Console**. The Console upgrade replaces your Satellite with the stock version, which would overwrite your custom code.
4+
5+
When the Console notifies you of a new version, use it as a reminder to update your dependencies and redeploy your custom build, as described below.
6+
7+
:::

docs/build/functions/development/rust.mdx

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ With this setup, only `on_set_doc` and `assert_set_doc` must be implemented with
3737

3838
---
3939

40-
## Maintenance
40+
## Upgrade
4141

4242
After deployment, keeping your Satellite functional and optimized requires ongoing monitoring and updates. Staying up to date is also a key factor, as we may introduce new features that need to be integrated into your Satellite to ensure full functionality within the Juno Console.
4343

44-
Since your project includes all Satellite features using `include_satellite!();`, it's essential to stay in sync with Junos updates to maintain compatibility.
44+
Since your project includes all Satellite features using `include_satellite!();`, it's essential to stay in sync with Juno's updates to maintain compatibility.
4545

46-
import Caution from "./components/upgrade-caution.mdx";
46+
import Danger from "./components/upgrade-danger.mdx";
4747

48-
<Caution />
48+
<Danger />
4949

50-
### Updating Your Satellite
50+
### What to do
5151

5252
To upgrade your Satellite, bump the dependencies in your `Cargo.toml` file located in `/src/satellite/`. The key dependencies to check and update are:
5353

@@ -59,10 +59,16 @@ To upgrade your Satellite, bump the dependencies in your `Cargo.toml` file locat
5959

6060
If other crates in your project depend on these, they should also be upgraded accordingly.
6161

62+
Once updated, build your functions and redeploy using the CLI or the GitHub Actions flow.
63+
6264
The recommended versions for each release can be found in the [changelog](/changelog) or [release notes on GitHub](https://github.com/junobuild/juno/releases).
6365

6466
If you need assistance, feel free to reach out through the available support channels.
6567

68+
import Caution from "./components/upgrade-caution.mdx";
69+
70+
<Caution />
71+
6672
---
6773

6874
## Versioning

docs/build/functions/development/typescript.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,26 @@ This page covers advanced options for writing serverless functions in TypeScript
44

55
---
66

7-
## Maintenance
7+
## Upgrade
88

99
Since your project includes all Satellite features, it's essential to stay in sync with Juno’s updates to maintain compatibility.
1010

1111
Always check the [releases](https://github.com/junobuild/juno/releases) page for the latest changes, and update your local container image (source [repo](https://github.com/junobuild/juno-docker)) accordingly to ensure you're running the latest runtime and features.
1212

13+
import Danger from "./components/upgrade-danger.mdx";
14+
15+
<Danger />
16+
17+
### What to do
18+
19+
The most important step is to keep your local Docker image up to date by pulling the latest version. The entire toolchain is shipped within the emulator, so you don't have to install additional tools on your machine, but it also means the image needs to stay current.
20+
21+
Check the [releases](https://github.com/junobuild/juno/releases) page to know when a new image is available.
22+
23+
If a release also includes updates to the JavaScript library, bump the relevant package in your project accordingly.
24+
25+
If you deploy with GitHub Actions, your workflow always inherits the latest image, so triggering a new CI run is enough to stay up to date, unless you have pinned a specific action version, in which case update it to `latest`.
26+
1327
import Caution from "./components/upgrade-caution.mdx";
1428

1529
<Caution />

0 commit comments

Comments
 (0)