@grafana/create-plugin 6.2.0-canary.2283.19226023221.0 → 6.2.0-canary.2314.19503588692.0

package/templates/common/.config/types/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

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

@@ -187,7 +187,7 @@ const config = async (env: Env): Promise<Configuration> => {
       new ReplaceInFileWebpackPlugin([
         {
           dir: DIST_DIR,
-          files: ['plugin.json', 'README.md'],
+          test: [/(^|\/)plugin\.json$/, /(^|\/)README\.md$/],
           rules: [
             {
               search: /\%VERSION\%/g,

package/templates/common/_package.json

@@ -16,7 +16,7 @@
   "author": "{{ sentenceCase orgName }}",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@grafana/eslint-config": "^8.2.0",
+    "@grafana/eslint-config": "^9.0.0",
     "@grafana/plugin-e2e": "^3.0.1",
     "@grafana/tsconfig": "^2.0.1",
     "@playwright/test": "^1.52.0",{{#if useExperimentalRspack}}
@@ -33,7 +33,6 @@
     "@types/react": "^18.3.0",
     "@types/react-dom": "^18.3.0",{{#if isAppType}}{{#unless useReactRouterV6}}
     "@types/react-router-dom": "^{{ reactRouterVersion }}",{{/unless}}{{/if}}
-    "@types/testing-library__jest-dom": "5.14.8",
     "@typescript-eslint/eslint-plugin": "^8.3.0",
     "@typescript-eslint/parser": "^8.3.0",{{#unless useExperimentalRspack}}
     "copy-webpack-plugin": "^11.0.0",{{/unless}}
@@ -42,7 +41,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-jsdoc": "^51.2.3",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-hooks": "^7.0.0",
     "eslint-webpack-plugin": "^5.0.0",{{#unless useExperimentalRspack}}
     "fork-ts-checker-webpack-plugin": "^8.0.0",{{/unless}}
     "glob": "^10.2.7",

package/templates/github/workflows/bundle-stats.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
 

package/templates/github/workflows/ci.yml

@@ -25,16 +25,16 @@ jobs:
     env:
       GRAFANA_ACCESS_POLICY_TOKEN: $\{{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'
@@ -61,7 +61,7 @@ jobs:
 
       - name: Setup Go environment
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: '1.22'
 
@@ -122,7 +122,7 @@ jobs:
           ARCHIVE: $\{{ steps.metadata.outputs.archive }}
 
       - name: Archive Build
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: $\{{ steps.metadata.outputs.plugin-id }}-$\{{ steps.metadata.outputs.plugin-version }}
           path: $\{{ steps.metadata.outputs.plugin-id }}
@@ -140,7 +140,7 @@ jobs:
       matrix: $\{{ steps.resolve-versions.outputs.matrix }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
 
@@ -162,12 +162,12 @@ jobs:
     name: e2e test $\{{ matrix.GRAFANA_IMAGE.name }}@$\{{ matrix.GRAFANA_IMAGE.VERSION }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 
       - name: Download plugin
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v6
         with:
           path: dist
           name: $\{{ needs.build.outputs.plugin-id }}-$\{{ needs.build.outputs.plugin-version }}
@@ -180,10 +180,10 @@ jobs:
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'
@@ -242,7 +242,7 @@ jobs:
     needs: [playwright-tests]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           # required for playwright-gh-pages
           persist-credentials: true

package/templates/github/workflows/cp-update.yml

@@ -15,7 +15,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: grafana/plugin-actions/create-plugin-update@create-plugin-update/v1.1.0
+      - uses: grafana/plugin-actions/create-plugin-update@create-plugin-update/v2.0.1
         with:
           # Make sure to save the token in your repository secrets as `GH_PAT_TOKEN`
           token: $\{{ secrets.GH_PAT_TOKEN }}

package/templates/github/workflows/is-compatible.yml

@@ -7,18 +7,18 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+      - uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
 {{/if_eq}}
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'

package/templates/github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       contents: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 

package/templates/panel/.config/AGENTS/fundamentals.md

@@ -0,0 +1,66 @@
+## Project overview
+
+This repository contains a Grafana panel plugin, which adds a custom visualization that can be used in Grafana dashboards. Panel plugins are useful when you want to:
+
+- Present data from Grafana data source queries in a new or specialized way
+- Add custom interactivity, such as navigation or drill-downs
+- Visualize or control external systems (for example, IoT devices or custom integrations)
+
+### High-level anatomy of a Grafana panel plugin
+
+A typical panel plugin has:
+
+- A plugin **manifest** (`plugin.json`)
+  - Declares plugin ID, type (`panel`), name, version, and metadata
+  - Picked up by Grafana during boot time to register plugin.
+
+- A **main module** (usually `src/module.ts` or `src/module.tsx`)
+  - Calls `new PanelPlugin(PanelComponent)` from `@grafana/data` and expose the instance from the module.
+  - Optionally wires in the options editor, panel migration handler, and panel defaults
+
+- A panel React component (e.g. `src/components/Panel.tsx`)
+  - Renders the visualization
+  - Receives props such as `data`, `timeRange`, `width`, `height`, and `options`
+  - Works with Grafana data frames and field configuration APIs to read query results and settings.
+
+## Goals for AI coding agents
+
+When working on this project, AI agents should:
+
+- Maintain the existing options schema unless a proper migration handler is implemented
+- Follow idiomatic React and TypeScript practices consistent with Grafana’s official example plugins
+- Treat AGENTS.md as the authoritative source. If anything in .config/AGENTS conflicts with this file, follow the instructions in AGENTS.md
+
+## Repository layout (typical)
+
+- `plugin.json` – Grafana plugin manifest (type: `panel`)
+- `src/module.ts` – main plugin entry point (creates `PanelPlugin`)
+- `src/components` – React components for the panel
+- `src/types.ts` – TypeScript types for panel options and internal models
+- `tests/` – End-to-end tests (if configured)
+- `provisioning/` - Provisioning files used in the local development environment.
+- `README.md` – Human-facing project documentation
+
+## Coding guidelines
+
+- Use **TypeScript** for all plugin code.
+- Prefer **functional React components** and hooks.
+- Use **Grafana UI components** (`@grafana/ui`) and **Grafana data APIs** (`@grafana/data`) or **Grafana runtime APIs** (`@grafana/runtime`) instead of custom UI or data abstractions whenever possible.
+- Keep the panel responsive:
+  - Respect `width` and `height` props.
+  - Avoid fixed layout sizes that break in narrow panels or large screens.
+- Avoid introducing new dependencies unless:
+  - They’re necessary
+  - They’re compatible with Grafana’s frontend environment and plugin guidelines
+- If custom styling is needed, please using `Emotion`.
+
+## Safety & constraints for agents
+
+- Do **not** change `plugin.json` IDs or plugin type.
+- Do **not** change anything in the `.config` folder.
+- Do **not** add a backend to this plugin. A panel plugin is a frontend only plugin.
+- Do **not** remove or break existing option fields without:
+  - Adding a migration handler, or
+  - Updating all usages and tests accordingly.
+- Keep changes to public interfaces (options, field configs, panel props) backwards compatible where possible.
+- When in doubt, mirror patterns from Grafana’s official panel plugin examples and docs.

package/templates/panel/AGENTS.md

@@ -0,0 +1,3 @@
+## Project overview
+
+This repository contains a **Grafana panel plugin**. Fundamentals of a grafana plugin can be found [here](./config/AGENTS/fundamentals.md)