升级 Metabase 和嵌入式分析 SDK

以下是升级 SDK 时需要执行的步骤的概览。

1. 阅读 Metabase 和嵌入式分析 SDK 的发布公告和更新日志

• 发布公告 提供了每个版本内容的良好概览，并指出了重大更改（很少见）。
• Metabase 更新日志 列出了所有 Metabase 和嵌入式分析 SDK 的更改。
• 嵌入式分析 SDK 更新日志 列出了特定于 SDK 的 @metabase/embedding-sdk-react 包的更改。

检查任何相关的更改，特别是那些需要您更新应用程序代码的弃用或重大更改。如果存在弃用更改，我们将提供文档来指导您需要进行哪些更改以及原因。

2. 测试升级

升级到新主版本时，您需要并行升级 Metabase 和 SDK 版本，因为 Metabase 和 SDK 的主版本不同步可能会导致错误。

启动新版本的 Metabase 进行测试

您可以在本地或开发实例中执行此操作。如果您的测试设置涉及大量测试用户帐户，那么拥有一个 开发实例 可能会更具成本效益。

请参阅 升级 Metabase。

使用 npm 或 Yarn 升级 SDK

您需要先在本地测试更改，因为可能存在需要您升级应用程序代码的重大更改。

在您的应用程序中检出新分支，然后使用 npm 或 Yarn 安装下一个稳定版本

通过 npm

npm install @metabase/embedding-sdk-react@{next-major-version-number}-stable

例如，如果您要将 SDK 升级到 56 版

npm install @metabase/embedding-sdk-react@56-stable

如果您使用 Yarn

yarn add @metabase/embedding-sdk-react@{next-major-version-number}-stable

有关 SDK 版本 的更多信息。

如果存在弃用或重大更改，请对您的应用程序代码进行必要的更改

弃用或重大更改很少见，但如果您需要进行更改，我们会在新主版本的发行说明中提及，并提供文档指导您完成更改。

更新或添加您所做的任何应用程序代码更改的测试。

在大多数情况下，弃用的更改将在其弃用后的下一个版本中成为重大更改。例如，如果我们计划从 SDK React 组件中删除一个 prop，我们会先将其标记为已弃用，然后在下一个版本中删除它。

部署到您的暂存环境

在将您的应用程序部署到暂存环境之前，请确保您已在本地测试了您的应用程序（手动进行，以及运行任何自动化测试）。

如果您的本地测试一切顺利，请部署到您的暂存环境。检查您的暂存应用程序中的 Metabase 嵌入内容是否仍按预期工作，并执行您通常对嵌入式分析应用程序执行的其他任何测试。

3. 部署到生产环境

如果在暂存环境中一切正常，您就可以部署到生产环境了。

请务必并行部署您的应用程序更改和升级您的 Metabase，以便 SDK 版本和 Metabase 版本保持同步。

缓存可能会将升级延迟最多一分钟

这是故意的。升级后，Metabase 可能会在长达 60 秒的时间内（Cache-Control: public, max-age=60）仍然提供之前缓存的 SDK Bundle 版本。这个短暂的缓存窗口有助于确保快速的性能，同时允许更新快速传播。

如果您没有立即看到更改，请清除您的浏览器缓存，或者只需等待一分钟。之后，SDK 包将加载新部署的 SDK Bundle。

如果您的实例固定在 Metabase Cloud 上，您需要请求升级

如果您使用的是 Metabase Cloud，并且已 固定了您的 Metabase 版本，则需要通过 联系支持 来请求升级。

我们将与您协调，以便在您部署应用程序更改时升级您的实例。