Upgrade dashboard plugins
Upgrade your dashboard plugins from time to time to get the latest bug fixes and features.
You can upgrade the plugins by:
- Bootstrapping a new plugin, or
- Manually performing the necessary steps.
Bootstrap a new plugin
The safest way to perform the upgrade is to bootstrap a whole new plugin using the following command:
npx @gooddata/plugin-toolkit@latest dashboard-plugin init
- Specify the same name as your original plugin.
- Carry over the code you have in your plugin to ensure that all the dependencies, configuration, etc. are up-to-date.
- Test your plugin.
- Rebuild the plugin.
- Redeploy the plugin to the hosting of your choice.
Manually upgrade the plugin
If bootstrapping a new plugin doesn’t suit you, upgrade the plugin manually in this order.
Upgrade the @gooddata dependencies
Upgrade all the @gooddata dependencies to the latest stable version.
To find the version used in your plugin, check your package.json file for the version next to the "@gooddata/sdk-ui-dashboard" entry.
@gooddata/sdk-backend-bear in package.json, remove it. See Platform compatibility.To find the latest stable version available, run the following in your terminal:
npm view @gooddata/sdk-ui-dashboard dist-tags.latest
If the latest version is the same as the one you already have, your dependencies are already up to date and you can move to the next step.
If the versions are different, replace your version with the latest version available for all the @gooddata packages that have it in the package.json file.
Make sure to keep the carets (^) in. Then, run the install command of your package manager:
npm install
With yarn, run yarn install.
Check for updates in the config and harness files
The configuration files and the files in the harness folder may need changes too. Compare them with the plugin template of the version you are upgrading to, at https://github.com/gooddata/gooddata-ui-sdk/tree/vX.Y.Z/tools/dashboard-plugin-template (replace vX.Y.Z with that version).
webpack.config.cjs, ignore differences in the development server proxy settings that only reflect your own hostname and workspace; you do not need to update them.Test your plugin locally
Run your plugin locally using the npm start command and make sure it still behaves the way you want.
Build and deploy your plugin
Once your plugin works well, build it and deploy it to the hosting you are using for the plugin.
Related
Understand the dashboard plugin contract, lifecycle, bundling, runtime behavior, and maintenance requirements.
Scaffold a dashboard plugin, run it against a live dashboard, then build, host, register, and link it.
Implement the dashboard plugin lifecycle, customize visualizations, widgets, layouts, filters, and exports, and register dashboard event handlers.
Which GoodData.UI major works with GoodData Cloud, GoodData.CN, and GoodData Legacy, the Node.js, React, and TypeScript versions it needs, and which frameworks it supports.
The entry points GoodData.UI's ESM-only packages expose, the bundler, TypeScript, Node, and test runner requirements, and fixes for the common CommonJS errors.