@grafana/create-plugin 5.26.4 → 5.26.5

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# v5.26.5 (Thu Sep 18 2025)
+
+#### 🐛 Bug Fix
+
+- Create plugin: fix docker compose migration error [#2126](https://github.com/grafana/plugin-tools/pull/2126) ([@jackw](https://github.com/jackw))
+- Update dependency @grafana/eslint-config to v8.2.0 [#1889](https://github.com/grafana/plugin-tools/pull/1889) ([@renovate[bot]](https://github.com/renovate[bot]) [@mckn](https://github.com/mckn))
+
+#### Authors: 3
+
+- [@renovate[bot]](https://github.com/renovate[bot])
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Marcus Andersson ([@mckn](https://github.com/mckn))
+
+---
+
 # v5.26.4 (Fri Sep 12 2025)
 
 #### 🐛 Bug Fix

package/dist/migrations/scripts/001-update-grafana-compose-extend.js

@@ -16,6 +16,7 @@ async function migrate(context) {
   if (buildContext?.toString() !== "./.config") {
     return context;
   }
+  const keyValuePairsToRemove = [];
   visit(composeData, {
     Pair: (_key, pair, path) => {
       const keyPath = [];
@@ -30,11 +31,15 @@ async function migrate(context) {
       if (keyPath[0] === "services" && keyPath[1] === "grafana") {
         const baseValue = baseComposeData.getIn(keyPath);
         if (baseValue && JSON.stringify(pair.value) === JSON.stringify(baseValue)) {
-          composeData.deleteIn(keyPath);
+          keyValuePairsToRemove.push(keyPath);
         }
       }
     }
   });
+  keyValuePairsToRemove.sort((a, b) => b.length - a.length);
+  for (const keyPath of keyValuePairsToRemove) {
+    composeData.deleteIn(keyPath);
+  }
   visit(composeData, {
     Scalar: (_key, node, path) => {
       const keyPath = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.26.4",
+  "version": "5.26.5",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -46,7 +46,7 @@
     "@libs/version": "^1.0.2",
     "@types/glob": "^9.0.0",
     "@types/minimist": "^1.2.5",
-    "@types/semver": "^7.7.0",
+    "@types/semver": "^7.7.1",
     "@types/tmp": "^0.2.6",
     "@types/which": "^3.0.4",
     "eslint-plugin-react": "^7.37.5",
@@ -61,5 +61,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "756a017a7ee999fb29a1ad0ab1b8f1928a64793a"
+  "gitHead": "d7fb24a37991be25f4f99fefd361a7e85e64309f"
 }

package/src/migrations/scripts/001-update-grafana-compose-extend.test.ts

@@ -262,6 +262,63 @@ describe('001-update-grafana-compose-extend', () => {
     });
   });
 
+  it('should remove child key-value pairs before parents', async () => {
+    const context = new Context('/virtual');
+    context.addFile(
+      './docker-compose.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: './.config',
+              args: {
+                grafana_version: '${GRAFANA_VERSION:-9.5.3}',
+              },
+            },
+            environment: {
+              GF_INSTALL_PLUGINS: 'snuids-trafficlights-panel',
+              NODE_ENV: 'development',
+            },
+          },
+        },
+      })
+    );
+    context.addFile(
+      './.config/docker-compose-base.yaml',
+      stringify({
+        services: {
+          grafana: {
+            build: {
+              context: '.',
+              args: {
+                grafana_version: '${GRAFANA_VERSION:-11.5.3}',
+              },
+            },
+            environment: {
+              GF_INSTALL_PLUGINS: 'snuids-trafficlights-panel',
+              NODE_ENV: 'development',
+            },
+          },
+        },
+      })
+    );
+
+    await migrate(context);
+
+    const result = parse(context.getFile('./docker-compose.yaml') || '');
+    expect(result.services.grafana).toEqual({
+      extends: {
+        file: '.config/docker-compose-base.yaml',
+        service: 'grafana',
+      },
+      build: {
+        args: {
+          grafana_version: '${GRAFANA_VERSION:-9.5.3}',
+        },
+      },
+    });
+  });
+
   it('should preserve comments in the docker-compose file', async () => {
     const context = new Context('/virtual');
     const originalContent = `

package/src/migrations/scripts/001-update-grafana-compose-extend.ts

@@ -24,8 +24,10 @@ export default async function migrate(context: Context) {
   if (buildContext?.toString() !== './.config') {
     return context;
   }
+  // List of key value pairs to remove from the compose file
+  const keyValuePairsToRemove: string[][] = [];
 
-  // Remove items that match the base configuration
+  // Visit key value pairs to find those that match the base configuration
   visit(composeData, {
     Pair: ((
       _key: unknown,
@@ -44,17 +46,25 @@ export default async function migrate(context: Context) {
         keyPath.push(pair.key.value as string);
       }
 
-      // If the current pair is in the base configuration, remove it
+      // We only care about the grafana service
       if (keyPath[0] === 'services' && keyPath[1] === 'grafana') {
         const baseValue = baseComposeData.getIn(keyPath);
 
+        // If the current pair matches the base value, add it to the list of items to remove
         if (baseValue && JSON.stringify(pair.value) === JSON.stringify(baseValue)) {
-          composeData.deleteIn(keyPath);
+          keyValuePairsToRemove.push(keyPath);
         }
       }
     }) as visitorFn<Pair<unknown, unknown>>,
   });
 
+  // Sort the key paths by length to remove children before parents
+  keyValuePairsToRemove.sort((a, b) => b.length - a.length);
+
+  for (const keyPath of keyValuePairsToRemove) {
+    composeData.deleteIn(keyPath);
+  }
+
   visit(composeData, {
     Scalar: ((_key: unknown, node: Scalar, path: ReadonlyArray<Node | Document | Pair<unknown, unknown>>) => {
       const keyPath: string[] = [];

package/templates/common/_package.json

@@ -20,7 +20,7 @@
   "devDependencies": {
 {{#if useCypress}}    "@grafana/e2e": "^11.0.7",
     "@grafana/e2e-selectors": "^12.1.0",{{/if}}
-    "@grafana/eslint-config": "^8.0.0",{{#if usePlaywright}}
+    "@grafana/eslint-config": "^8.2.0",{{#if usePlaywright}}
     "@grafana/plugin-e2e": "^2.1.12",{{/if}}
     "@grafana/tsconfig": "^2.0.0",{{#if usePlaywright}}
     "@playwright/test": "^1.52.0",{{/if}}{{#if useExperimentalRspack}}