@grafana/create-plugin 1.12.2-canary.383.c40bea1.0 → 1.12.2

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v1.12.2 (Thu Sep 07 2023)
+
+#### 🐛 Bug Fix
+
+- fix: update dockerfile with platform [#383](https://github.com/grafana/plugin-tools/pull/383) ([@sympatheticmoose](https://github.com/sympatheticmoose))
+- chore: update links to developer portal [#382](https://github.com/grafana/plugin-tools/pull/382) ([@sympatheticmoose](https://github.com/sympatheticmoose))
+- Create plugin: Use latest Grafana version [#309](https://github.com/grafana/plugin-tools/pull/309) ([@dprokop](https://github.com/dprokop) [@academo](https://github.com/academo))
+
+#### Authors: 3
+
+- David Harris ([@sympatheticmoose](https://github.com/sympatheticmoose))
+- Dominik Prokop ([@dprokop](https://github.com/dprokop))
+- Esteban Beltran ([@academo](https://github.com/academo))
+
+---
+
 # v1.12.1 (Fri Aug 25 2023)
 
 :tada: This release contains work from a new contributor! :tada:

package/README.md

@@ -18,9 +18,7 @@ Create Grafana plugins with ease.
 
 **Links**
 
-- [Plugin Tools docs](https://grafana.github.io/plugin-tools/)
-- [Plugin developer docs](https://grafana.com/docs/grafana/latest/developers/plugins/)
-- [Plugin migration guide](https://grafana.com/docs/grafana/latest/developers/plugins/migration-guide)
+- [Plugin developer docs](https://grafana.com/developers/plugin-tools)
 
 **`@grafana/create-plugin`** works on macOS, Linux and Windows Subsystem for Linux (WSL).<br />
 If something doesn't work, please [file an issue](https://github.com/grafana/plugin-tools/issues/new).<br />
@@ -74,7 +72,7 @@ cd ./my-plugin
 npx @grafana/create-plugin@latest migrate
 ```
 
-For more information see [here](https://grafana.github.io/plugin-tools/docs/migrating-from-toolkit)
+For more information see [here](https://grafana.com/developers/plugin-tools/migration-guides/migrate-from-toolkit)
 
 ---
 
@@ -93,13 +91,13 @@ cd ./my-plugin
 npx @grafana/create-plugin@latest update
 ```
 
-For more information see [here](https://grafana.github.io/plugin-tools/docs/updating-to-new-releases)
+For more information see [here](https://grafana.com/developers/plugin-tools/migration-guides/update-create-plugin-versions)
 
 ---
 
 ## Customizing or extending the basic configs
 
-You can read more about customizing or extending the basic configuration [here](https://grafana.github.io/plugin-tools/docs/advanced-configuration/)
+You can read more about customizing or extending the basic configuration [here](https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations)
 
 ## Contributing
 

package/dist/commands/generate-actions/print-success-message.js

@@ -28,7 +28,7 @@ function printGenerateSuccessMessage(answers) {
         '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
         '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
     ], false);
-    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- View create-plugin documentation at https://grafana.github.io/plugin-tools/\n- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/\n");
+    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- Learn more about Grafana Plugin Development at https://grafana.com/developers/plugin-tools\n");
     return (0, utils_console_1.displayAsMarkdown)(msg);
 }
 exports.printGenerateSuccessMessage = printGenerateSuccessMessage;

package/dist/constants.js

@@ -32,7 +32,7 @@ var PLUGIN_TYPES;
     PLUGIN_TYPES["scenes"] = "scenesapp";
 })(PLUGIN_TYPES = exports.PLUGIN_TYPES || (exports.PLUGIN_TYPES = {}));
 exports.EXTRA_TEMPLATE_VARIABLES = {
-    grafanaVersion: '9.5.3',
+    grafanaVersion: '10.0.3',
     grafanaImage: 'grafana-enterprise'
 };
 exports.GRAFANA_FE_PACKAGES = [
@@ -83,7 +83,7 @@ exports.TEXT = {
     updateNpmScriptsSuccess: 'NPM scripts updated successfully.',
     updateNpmScriptsAborted: 'No NPM scripts have been added or updated.',
     migrationCommandWarning: '**⚠️  Warning!**\nThis is going to change files in your current project to make it up-to-date with the latest plugin configuration.\nPlease make sure that you have backed up your changes.',
-    migrationCommandSuccess: "\n## What's next?\n * Run `yarn install` to install the latest dependencies.\n * Check your tsconfig.json. You might need to update if you had a custom configuration.\n * If you have a custom webpack configuration you might need to update it too.\n * Run `yarn build` and observe the output for any errors.\n * Test your plugin in grafana and make sure everything works as expected.\n\nSee instructions on how to customize your configuration here https://grafana.github.io/plugin-tools/docs/advanced-configuration/\n  ",
+    migrationCommandSuccess: "\n## What's next?\n * Run `yarn install` to install the latest dependencies.\n * Check your tsconfig.json. You might need to update if you had a custom configuration.\n * If you have a custom webpack configuration you might need to update it too.\n * Run `yarn build` and observe the output for any errors.\n * Test your plugin in grafana and make sure everything works as expected.\n\nSee instructions on how to customize your configuration here https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations\n  ",
     updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',
     updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/plugin-tools.'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.12.2-canary.383.c40bea1.0",
+  "version": "1.12.2",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "c40bea125db7e370af69c9bcf9e25d5dbb457976"
+  "gitHead": "a9af24493908592b90c952c224bfc8c96d2b340d"
 }

package/src/commands/generate-actions/print-success-message.ts

@@ -29,8 +29,7 @@ ${commands.map((command) => command).join('\n')}
 
 _Note: We strongly recommend creating a new Git repository by running \`git init\` in ./${directory} before continuing._
 
-- View create-plugin documentation at https://grafana.github.io/plugin-tools/
-- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/
+- Learn more about Grafana Plugin Development at https://grafana.com/developers/plugin-tools
 `;
 
   return displayAsMarkdown(msg);

package/src/constants.ts

@@ -40,7 +40,7 @@ export enum PLUGIN_TYPES {
 // and will be available to use in the templates.
 // Example: "@grafana/ui": "{{ grafanaVersion }}"
 export const EXTRA_TEMPLATE_VARIABLES = {
-  grafanaVersion: '9.5.3',
+  grafanaVersion: '10.0.3',
   grafanaImage: 'grafana-enterprise',
 };
 
@@ -118,7 +118,7 @@ export const TEXT = {
  * Run \`yarn build\` and observe the output for any errors.
  * Test your plugin in grafana and make sure everything works as expected.
 
-See instructions on how to customize your configuration here https://grafana.github.io/plugin-tools/docs/advanced-configuration/
+See instructions on how to customize your configuration here https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations
   `,
 
   updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',

package/templates/common/.config/.eslintrc

@@ -2,7 +2,7 @@
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
  * In order to extend the configuration follow the steps in
- * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-eslint-config
+ * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-eslint-config
  */
  {
   "extends": ["@grafana/eslint-config"],

package/templates/common/.config/Dockerfile

@@ -1,7 +1,7 @@
 ARG grafana_version=latest
 ARG grafana_image=grafana-enterprise
 
-FROM --platform=linux/amd64 grafana/${grafana_image}:${grafana_version}
+FROM grafana/${grafana_image}:${grafana_version}
 
 # Make it as simple as possible to access the grafana instance for development purposes
 # Do NOT enable these settings in a public facing / production grafana instance

package/templates/common/.config/jest-setup.js

@@ -2,7 +2,7 @@
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
  * In order to extend the configuration follow the steps in
- * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-jest-config
+ * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-jest-config
  */
 
 import '@testing-library/jest-dom';

package/templates/common/.config/jest.config.js

@@ -2,7 +2,7 @@
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
  * In order to extend the configuration follow the steps in
- * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-jest-config
+ * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-jest-config
  */
 
 const path = require('path');

package/templates/common/.config/tsconfig.json

@@ -2,7 +2,7 @@
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
  * In order to extend the configuration follow the steps in
- * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-typescript-config
+ * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-typescript-config
  */
  {
   "compilerOptions": {

package/templates/common/.config/webpack/webpack.config.ts

@@ -2,7 +2,7 @@
  * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
  *
  * In order to extend the configuration follow the steps in
- * https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-webpack-config
+ * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-webpack-config
  */
 
 import CopyWebpackPlugin from 'copy-webpack-plugin';

package/templates/common/docker-compose.yaml

@@ -3,10 +3,9 @@ version: '3.0'
 services:
   grafana:
     container_name: '{{ pluginId }}'
+    platform: "linux/amd64"
     build:
       context: ./.config
-      platforms:
-      - "linux/amd64"
       args:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
         grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }

package/templates/common/package.json

@@ -61,8 +61,8 @@
     "@grafana/data": "{{ grafanaVersion }}",
     "@grafana/runtime": "{{ grafanaVersion }}",
     "@grafana/ui": "{{ grafanaVersion }}",{{#if_eq pluginType "scenesapp"}}
-    "@grafana/schema": "10.0.1",
-    "@grafana/scenes": "^0.19.0",{{/if_eq}}
+    "@grafana/schema": "{{ grafanaVersion }}",
+    "@grafana/scenes": "0.27.0",{{/if_eq}}
     "react": "17.0.2",
     "react-dom": "17.0.2",{{#if isAppType}}
     "react-router-dom": "^5.2.0",

package/templates/scenes-app/README.md

@@ -1,6 +1,6 @@
 # Grafana Scenes App Plugin Template
 
-This template is a starting point for building an app plugin with [scenes](https://grafana.github.io/scenes) for Grafana.
+This template is a starting point for building an app plugin with [scenes](https://grafana.com/developers/scenes) for Grafana.
 
 ## What are Grafana app plugins?
 
@@ -10,7 +10,7 @@ App plugins can let you create a custom out-of-the-box monitoring experience by
 
 [@grafana/scenes](https://github.com/grafana/scenes) is a framework to enable versatile app plugins implementation. It provides an easy way to build apps that resemble Grafana's dashboarding experience, including template variables support, versatile layouts, panels rendering and more.
 
-To learn more about @grafana/scenes usage please refer to the [documentation](https://grafana.github.io/scenes)
+To learn more about @grafana/scenes usage please refer to the [documentation](https://grafana.com/developers/scenes)
 
 ## What does this template contain?