@grafana/create-plugin 6.3.0-canary.2314.19530781115.0 → 6.3.0-canary.2314.19540148969.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v6.2.1 (Thu Nov 20 2025)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: use migration description for commit messages [#2315](https://github.com/grafana/plugin-tools/pull/2315) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v6.2.0 (Thu Nov 20 2025)
 
 #### 🚀 Enhancement

package/dist/codemods/migrations/manager.js

@@ -20,7 +20,9 @@ async function runMigrations(migrations, options = {}) {
     const context = await runCodemod(migration, options.codemodOptions);
     const shouldCommit = options.commitEachMigration && context.hasChanges();
     if (shouldCommit) {
-      await gitCommitNoVerify(`chore: run create-plugin migration - ${migration.name} (${migration.scriptPath})`);
+      await gitCommitNoVerify(`chore: run create-plugin migration - ${migration.name}
+
+${migration.description}`);
     }
   }
   setRootConfig({ version: CURRENT_APP_VERSION });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.3.0-canary.2314.19530781115.0",
+  "version": "6.3.0-canary.2314.19540148969.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -61,5 +61,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "557249374a482491ab555bc19311b07087bb3726"
+  "gitHead": "57c7ea99cf1008bc7c1fa894c2cb13ffddfc2a70"
 }

package/src/codemods/migrations/manager.ts

@@ -38,7 +38,8 @@ export async function runMigrations(migrations: Migration[], options: RunMigrati
     const shouldCommit = options.commitEachMigration && context.hasChanges();
 
     if (shouldCommit) {
-      await gitCommitNoVerify(`chore: run create-plugin migration - ${migration.name} (${migration.scriptPath})`);
+      // for conventional commits we need to add a newline between the title and the description
+      await gitCommitNoVerify(`chore: run create-plugin migration - ${migration.name}\n\n${migration.description}`);
     }
   }
 

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

@@ -0,0 +1,83 @@
+---
+name: panel-plugin-agent-fundamentals
+description: Develops Grafana panel plugins
+---
+
+You are an expert Grafana panel plugin developer for this project.
+
+## Your role
+
+- You are fluent in TypeScript and React
+- You know how to use Grafana dashboards
+
+## Project knowledge
+
+This repository contains a **Grafana panel plugin**, providing a custom visualization for Grafana dashboards.
+Panel plugins are used to:
+
+- Display data from Grafana data sources in custom ways
+- Add interactive behavior (drill-downs, navigation, etc.)
+- Visualize or control external systems (IoT, integrations, custom controls)
+
+### Plugin anatomy
+
+A typical panel plugin includes:
+
+**plugin.json**
+
+- Declares plugin ID, type (`panel`), name, version
+- Loaded by Grafana at startup
+
+**Main module (`src/module.ts`)**
+
+- Exports: `new PanelPlugin(PanelComponent)`
+- Registers panel options, migrations, defaults, ui extensions
+
+**Panel component (`src/components/Panel.tsx`)**
+
+- React component receiving: `data`, `timeRange`, `width`, `height`, `options`
+- Renders visualization using Grafana data frames and field configs
+
+### Repository layout
+
+- `plugin.json` — Panel plugin manifest
+- `src/module.ts` — Main plugin entry
+- `src/components/` — Panel React components
+- `src/types.ts` — Option and model types
+- `tests/` — E2E tests (if present)
+- `provisioning/` — Local development provisioning
+- `README.md` — Human documentation
+
+## Coding guidelines
+
+- Use **TypeScript** and **functional React components**
+- Use **@grafana/ui**, **@grafana/data**, **@grafana/runtime**
+- Respect `width` and `height`; keep layout responsive
+- Avoid unnecessary dependencies; ensure Grafana compatibility
+- Use useTheme2() from @grafana/ui for visual tokens
+- Never hardcode colors, spacing, padding, or font sizes.
+- Use useStyles2(), Emotion and visual tokens from the theme to create styles.
+- Follow existing file structure
+- Keep code typed and predictable
+
+## Boundaries
+
+You must **not**:
+
+- Change plugin IDs or plugin type in `plugin.json`
+- Modify anything under `.config/*`
+- Add a backend — panel plugins are **frontend only**
+- Remove or change existing options without a migration handler
+- Break public APIs (options, field configs, panel props)
+- Store or use credentials.
+
+You **should**:
+
+- Keep the plugin backward compatible
+- Preserve the existing options schema unless adding a migration handler
+- Mirror patterns from Grafana’s official panel plugin examples
+- Follow idiomatic React + TypeScript patterns used in official Grafana examples
+
+## Instructions for specific tasks
+
+- [Add panel options](./tasks/add-panel-options.md)

package/templates/panel/.config/AGENTS/tasks/add-panel-options.md

@@ -1,5 +1,7 @@
 # Adding a New Panel Option
 
+Panel options are settings the user configures to change panel behavior.
+
 Always complete **all three steps**:
 
 ### **1. Extend the options type**
@@ -13,8 +15,8 @@ export interface SimpleOptions {
 }
 ```
 
-* Property name must match the builder `path`.
-* Type must match expected editor output.
+- Property name must match the builder `path`.
+- Type must match expected editor output.
 
 ---
 
@@ -53,9 +55,9 @@ builder.addXxx({
 
 Rules:
 
-* Every option **must** have a `defaultValue`.
-* Put numeric constraints in `settings` (`min`, `max`, `step`).
-* Use `showIf` for conditional display.
+- Every option **must** have a `defaultValue`.
+- Put numeric constraints in `settings` (`min`, `max`, `step`).
+- Use `showIf` for conditional display.
 
 ---
 
@@ -127,4 +129,4 @@ No option may remain unused.
   ]},
   showIf: (o) => o.showSize,
 })
-```
+```

package/templates/panel/AGENTS.md

@@ -5,4 +5,6 @@ description: Develops Grafana panel plugins
 
 ## Project knowledge
 
-This repository contains a **Grafana panel plugin**. Apply the [instructions](./.config/AGENTS/instructions.md) before doing any changes.
+This repository contains a **Grafana panel plugin**. Follow the [instructions](./.config/AGENTS/instructions.md) before doing any changes.
+
+All build, lint, test, and Docker dev-server commands are documented in the "Getting started" section of [README.md](./README.md). Prefer running the non-watch versions of these commands.