You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/master/embedding/sdk/version.md
+16-13Lines changed: 16 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -15,32 +15,35 @@ layout: new-docs
15
15
16
16
The SDK stable version tracks with the Metabase version.
17
17
18
-
So, for example, if you're on Metabase 55 (`0.55.x`, `1.55.x`), _any_ version 0.55.x of the @metabase/embedding-sdk-react npm package will be compatible.
18
+
So, for example, if you're on Metabase 53 (`0.53.x`, `1.53.x`), _any_ version 0.53.x of the @metabase/embedding-sdk-react npm package will be compatible.
19
19
20
-
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 55, run:
20
+
To simplify things, we publish dist-tags for each stable Metabase version. For example, to install the latest version of the SDK compatible with Metabase 53, run:
To grab the latest version of the SDK that works with Metabase nightly builds, use the `canary` dist-tag.
27
27
28
28
## Minimum SDK version
29
29
30
-
Version 52 is the minimum version supported for the Embedded analytics SDK.
30
+
52 is the minimum version supported for the Embedded analytics SDK.
31
31
32
-
## Instances on Metabase Cloud will be pinned to a specific version
32
+
## Version pinning when using the SDK with Metabase Cloud
33
33
34
-
By default, if you're running on Metabase Cloud and using the Embedded analytics SDK, we'll pin your version to avoid breaking changes.
34
+
To pin your version of Metabase, go to **Admin settings > Settings > Embedding**. Go to the Embedded analytics SDK card and scroll to **Version pinning** and click **Request version pinning**.
35
35
36
-
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so you don't have to deal with upgrades. But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
36
+
## Version pinning requirements
37
37
38
-
### Manually pinning your instance version on Metabase Cloud
38
+
To pin a version of Metabase, you must:
39
39
40
-
To manually pin your version of Metabase:
40
+
- Be on Metabase Cloud (obviously)
41
+
- Be on the Pro or Enterprise plans
41
42
42
-
1. Go to **Admin settings > Settings > Embedding**.
43
-
2. Go to the Embedded analytics SDK card.
44
-
3. Scroll to **Version pinning** and click **Request version pinning**.
43
+
## Why you'd want to pin your Metabase Cloud version
45
44
46
-
This will open a mailto link to our support team.
45
+
Normally, Metabase Cloud upgrades your Metabase as new versions roll out so that you don't have to deal with upgrades.
46
+
47
+
But if you're using the SDK with Metabase Cloud, you'll want to upgrade manually to make sure your embeds don't break when you upgrade both your Metabase and your SDK version.
48
+
49
+
To upgrade manually, you can pin your Metabase version so that it stays in sync with the SDK version you're using. That way you can choose when to upgrade your Metabase.
Copy file name to clipboardExpand all lines: _docs/master/installation-and-operation/upgrading-metabase.md
+2-14Lines changed: 2 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,11 @@ redirect_from:
13
13
14
14
# Upgrading Metabase
15
15
16
-
This page covers how to upgrade to a new Metabase release.
17
-
18
-
-[Announcement posts for major releases](https://www.)
19
-
-[Changelogs](/changelog).
20
-
-[Release notes on GitHub](https://github.com/metabase/metabase/releases).
16
+
This page covers how to upgrade to a new [Metabase release](https://github.com/metabase/metabase/releases).
21
17
22
18
## Upgrading Metabase Cloud
23
19
24
-
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end ([unless you're using the Embedded analytics SDK](#instances-using-the-embedded-analtyics-sdk-on-metabase-cloud-must-request-an-upgrade)).
20
+
If you're on a [Metabase Cloud](/pricing/) plan, we'll upgrade your Metabase automatically with each new release; no action needed on your end.
25
21
26
22
How soon we upgrade you depends on the type of release:
27
23
@@ -30,14 +26,6 @@ How soon we upgrade you depends on the type of release:
30
26
31
27
Cloud customers can request an early upgrade by emailing support at [email protected]. Include the URL of the Metabase you want us to upgrade.
32
28
33
-
### Instances using the Embedded analtyics SDK on Metabase Cloud must request an upgrade
34
-
35
-
If you're using the [Embedded analytics SDK](../embedding/sdk/introduction) on Metabase Cloud, we pin your version so that it doesn't upgrade automatically, as you should test the changes before upgrading.
36
-
37
-
To upgrade your Metabase, you'll need to request an upgrade by [contacting support](/help-premium).
38
-
39
-
See our [upgrade guide for the Embedded analytics SDK](../embedding/sdk/upgrade).
40
-
41
29
## Upgrading a self-hosted Metabase
42
30
43
31
Here are the steps for upgrading to a new Metabase version (major or minor):
0 commit comments