@grafana/create-plugin 1.4.0-canary.246.a1ec25e.0 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,64 @@
+# v1.4.0 (Tue May 23 2023)
+
+#### 🚀 Enhancement
+
+- Create Plugin: App plugins with Top Nav support [#246](https://github.com/grafana/plugin-tools/pull/246) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v1.3.3 (Fri May 19 2023)
+
+#### 🐛 Bug Fix
+
+- create-plugin: updates for ci workflow [#242](https://github.com/grafana/plugin-tools/pull/242) ([@briangann](https://github.com/briangann))
+
+#### Authors: 1
+
+- Brian Gann ([@briangann](https://github.com/briangann))
+
+---
+
+# v1.3.2 (Thu May 18 2023)
+
+#### 🐛 Bug Fix
+
+- Chore: Update dev-dependencies [#232](https://github.com/grafana/plugin-tools/pull/232) ([@leventebalogh](https://github.com/leventebalogh) [@jackw](https://github.com/jackw))
+- Fix fonts not loaded correctly on generated bundles [#251](https://github.com/grafana/plugin-tools/pull/251) ([@academo](https://github.com/academo))
+
+#### 📝 Documentation
+
+- Create Plugin: Update readme for supported package managers [#244](https://github.com/grafana/plugin-tools/pull/244) ([@jackw](https://github.com/jackw))
+
+#### Authors: 3
+
+- Esteban Beltran ([@academo](https://github.com/academo))
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Levente Balogh ([@leventebalogh](https://github.com/leventebalogh))
+
+---
+
+# v1.3.1 (Mon May 15 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Fix react types errors [#238](https://github.com/grafana/plugin-tools/pull/238) ([@jackw](https://github.com/jackw))
+- chore: update grafanaDependency for datasources [#247](https://github.com/grafana/plugin-tools/pull/247) ([@sympatheticmoose](https://github.com/sympatheticmoose))
+
+#### 📝 Documentation
+
+- docs: readme update for windows [#240](https://github.com/grafana/plugin-tools/pull/240) ([@sympatheticmoose](https://github.com/sympatheticmoose))
+
+#### Authors: 2
+
+- David Harris ([@sympatheticmoose](https://github.com/sympatheticmoose))
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v1.3.0 (Fri Apr 28 2023)
 
 #### 🚀 Enhancement

package/README.md

@@ -7,10 +7,10 @@ Create Grafana plugins with ease.
 - [Grafana / Create Plugin](#grafana--create-plugin)
   - [Create a new plugin](#create-a-new-plugin)
     - [Quick overview](#quick-overview)
-      - [`yarn` (1.x)](#yarn-1x)
-      - [`yarn` (\> 2.x)](#yarn--2x)
       - [`npx`](#npx)
       - [`npm`](#npm)
+      - [`pnpm`](#pnpm)
+      - [`yarn` (1.x)](#yarn-1x)
   - [Migrate your existing plugin](#migrate-your-existing-plugin)
   - [Update your plugin build config](#update-your-plugin-build-config)
   - [Customizing or extending the basic configs](#customizing-or-extending-the-basic-configs)
@@ -32,30 +32,30 @@ If you have questions or need help, please ask in [GitHub Discussions](https://g
 
 Run the command in the folder where you want to store your plugins. The new plugin will be scaffolded in a sub-directory of the folder where you run the command.
 
-You can run the command with the package manager of your choice:
+Create Plugin can be used with NPM, PNPM or Yarn 1. The plugin will be scaffolded to use your preferred package manager. Run the command with the package manager of your choice:
 
-#### [`yarn`](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) (1.x)
+#### [`npx`](https://github.com/npm/npx)
 
 ```bash
-yarn create @grafana/plugin
+npx @grafana/create-plugin@latest
 ```
 
-#### [`yarn`](https://yarnpkg.com/cli/dlx) (> 2.x)
+#### [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-init)
 
 ```bash
-yarn dlx @grafana/create-plugin
+npm init @grafana/plugin
 ```
 
-#### [`npx`](https://github.com/npm/npx)
+#### [`pnpm`](https://pnpm.io/cli/dlx)
 
 ```bash
-npx @grafana/create-plugin@latest
+pnpm dlx @grafana/create-plugin@latest
 ```
 
-#### [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-init)
+#### [`yarn`](https://classic.yarnpkg.com/blog/2017/05/12/introducing-yarn/) (1.x)
 
 ```bash
-npm init @grafana/plugin
+yarn create @grafana/plugin
 ```
 
 ---

package/dist/constants.js

@@ -30,7 +30,7 @@ var PLUGIN_TYPES;
     PLUGIN_TYPES["secretsmanager"] = "secretsmanager";
 })(PLUGIN_TYPES = exports.PLUGIN_TYPES || (exports.PLUGIN_TYPES = {}));
 exports.EXTRA_TEMPLATE_VARIABLES = {
-    grafanaVersion: '9.5.0'
+    grafanaVersion: '9.5.2'
 };
 exports.GRAFANA_FE_PACKAGES = [
     '@grafana/data',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.4.0-canary.246.a1ec25e.0",
+  "version": "1.4.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -64,5 +64,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "a1ec25e1edd29311ef1896795e1ac0224755565f"
+  "gitHead": "bd765873e928d1c305627e3b7224f3408db42863"
 }

package/src/constants.ts

@@ -38,7 +38,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.0',
+  grafanaVersion: '9.5.2',
 };
 
 export const GRAFANA_FE_PACKAGES = [

package/templates/app/src/components/AppConfig/AppConfig.tsx

@@ -15,7 +15,7 @@ type State = {
   apiUrl: string;
   // Tells us if the API key secret is set.
   isApiKeySet: boolean;
-  // An secret key for our custom API.
+  // A secret key for our custom API.
   apiKey: string;
 };
 

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

@@ -117,7 +117,7 @@ const config = async (env): Promise<Configuration> => ({
         type: 'asset/resource',
         generator: {
           // Keep publicPath relative for host.com/grafana/ deployments
-          publicPath: `public/plugins/${pluginJson.id}/fonts`,
+          publicPath: `public/plugins/${pluginJson.id}/fonts/`,
           outputPath: 'fonts/',
           filename: Boolean(env.production) ? '[hash][ext]' : '[name][ext]',
         },

package/templates/common/package.json

@@ -18,39 +18,39 @@
   "author": "{{ sentenceCase orgName }}",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@babel/core": "^7.16.7",
+    "@babel/core": "^7.21.4",
     "@grafana/e2e": "{{ grafanaVersion }}",
     "@grafana/e2e-selectors": "{{ grafanaVersion }}",
     "@grafana/eslint-config": "^5.1.0",
     "@grafana/tsconfig": "^1.2.0-rc1",
     "@swc/core": "^1.3.51",
     "@swc/helpers": "^0.5.0",
-    "@swc/jest": "^0.2.23",
-    "@testing-library/jest-dom": "^5.16.2",
+    "@swc/jest": "^0.2.26",
+    "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^12.1.4",
-    "@types/jest": "^29.2.2",
-    "@types/lodash": "^4.14.188",
-    "@types/node": "^18.11.9",{{#if_eq pluginType "app"}}
+    "@types/jest": "^29.5.0",
+    "@types/lodash": "^4.14.194",
+    "@types/node": "^18.15.11",{{#if_eq pluginType "app"}}
     "@types/react-router-dom": "^5.3.3",{{/if_eq}}
     "copy-webpack-plugin": "^11.0.0",
-    "css-loader": "^6.7.1",
-    "eslint-webpack-plugin": "^3.1.1",
-    "fork-ts-checker-webpack-plugin": "^7.2.0",
-    "glob": "^10.0.0",
+    "css-loader": "^6.7.3",
+    "eslint-webpack-plugin": "^4.0.1",
+    "fork-ts-checker-webpack-plugin": "^8.0.0",
+    "glob": "^10.1.0",
     "identity-obj-proxy": "3.0.0",
-    "jest": "^29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
-    "prettier": "^2.5.0",
+    "jest": "^29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "prettier": "^2.8.7",
     "replace-in-file-webpack-plugin": "^1.0.6",
-    "sass": "1.56.1",
-    "sass-loader": "13.2.0",
-    "style-loader": "3.3.1",
+    "sass": "1.62.1",
+    "sass-loader": "13.2.2",
+    "style-loader": "3.3.2",
     "swc-loader": "^0.2.3",
-    "ts-node": "^10.5.0",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "^4.4.0",
-    "webpack": "^5.69.1",
-    "webpack-cli": "^4.9.2",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "4.8.4",
+    "webpack": "^5.79.0",
+    "webpack-cli": "^5.0.1",
     "webpack-livereload-plugin": "^3.0.2"
   },
   "engines": {

package/templates/github/ci/.github/workflows/ci.yml

@@ -39,15 +39,6 @@ jobs:
       - name: Build frontend
         run: {{ packageManagerName }} run build
 
-      - name: Start grafana docker
-        run: docker-compose up -d
-
-      - name: Run e2e tests
-        run: {{ packageManagerName }} run e2e
-
-      - name: Stop grafana docker
-        run: docker-compose down
-
       - name: Check for backend
         id: check-for-backend
         run: |
@@ -60,7 +51,7 @@ jobs:
         if: steps.check-for-backend.outputs.has-backend == 'true'
         uses: actions/setup-go@v3
         with:
-          go-version: '1.19'
+          go-version: '1.20'
 
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
@@ -75,3 +66,31 @@ jobs:
         with:
           version: latest
           args: buildAll
+
+      - name: Check for E2E
+        id: check-for-e2e
+        run: |
+          if [ -d "cypress" ]
+          then
+            echo "has-e2e=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Start grafana docker
+        if: steps.check-for-e2e.outputs.has-e2e == 'true'
+        run: docker-compose up -d
+
+      - name: Run e2e tests
+        if: steps.check-for-e2e.outputs.has-e2e == 'true'
+        run: {{ packageManagerName }} run e2e
+
+      - name: Stop grafana docker
+        if: steps.check-for-e2e.outputs.has-e2e == 'true'
+        run: docker-compose down
+
+      - name: Archive E2E output
+        uses: actions/upload-artifact@v3
+        if: steps.check-for-e2e.outputs.has-e2e == 'true' && steps.run-e2e-tests.outcome != 'success'
+        with:
+          name: cypress-videos
+          path: cypress/videos
+          retention-days: 5