Create Plugin: Add docker-compose migration for extending from .config #1621

jackw · 2025-03-14T17:26:28Z

What this PR does / why we need it:
This PR introduces the first migration script that aims to update plugins ./docker-compose.yaml to extend from the ./.config/docker-compose-base.yaml.

It can be tested locally by passing --experimental-updates along with the update command.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

npm install @libs/[email protected]
npm install @grafana/[email protected]
npm install @grafana/[email protected]
npm install @grafana/[email protected]
npm install @grafana/[email protected]
npm install @grafana/[email protected]
# or 
yarn add @libs/[email protected]
yarn add @grafana/[email protected]
yarn add @grafana/[email protected]
yarn add @grafana/[email protected]
yarn add @grafana/[email protected]
yarn add @grafana/[email protected]

github-actions · 2025-03-14T17:26:42Z

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged and will trigger a new patch release.
NOTE: When merging a PR with the release label please avoid merging another PR. For further information see here.

academo · 2025-04-11T07:36:27Z

packages/create-plugin/src/migrations/scripts/001-update-grafana-compose-extend.test.ts

+import migrate from './001-update-grafana-compose-extend.js';
+import { parse, stringify } from 'yaml';
+
+describe('001-update-grafana-compose-extend', () => {


the only thing that came to my mind is that this also preserves comments in the file. could you add a test case for that?

Thanks for taking a look at this @academo. I've updated the migration to use the parse document and visit apis from yaml which preserves comments.

andresmgot

I haven't tried this but the testing is pretty extensive so LGTM!

andresmgot · 2025-04-25T08:51:14Z

packages/create-plugin/src/migrations/scripts/001-update-grafana-compose-extend.ts

+  visit(composeData, {
+    Pair: ((
+      _key: unknown,
+      pair: Pair<unknown, unknown>,
+      path: ReadonlyArray<Node | Document | Pair<unknown, unknown>>
+    ) => {
+      const keyPath: string[] = [];
+      for (const p of path) {
+        if (p instanceof Pair && p.key instanceof Scalar) {
+          keyPath.push(p.key.value as string);
+        }
+      }
+
+      if (pair.key instanceof Scalar) {
+        keyPath.push(pair.key.value as string);
+      }
+
+      if (keyPath[0] === 'services' && keyPath[1] === 'grafana') {
+        const baseValue = baseComposeData.getIn(keyPath);
+
+        if (baseValue && JSON.stringify(pair.value) === JSON.stringify(baseValue)) {
+          composeData.deleteIn(keyPath);
+        }
+      }
+    }) as visitorFn<Pair<unknown, unknown>>,
+  });


maybe a comment here of what the goal of this block is would help

andresmgot · 2025-04-25T08:53:57Z

packages/create-plugin/src/migrations/scripts/001-update-grafana-compose-extend.ts

+  composeData.deleteIn(['services', 'grafana', 'build', 'context']);
+  const build = composeData.getIn(['services', 'grafana', 'build']);
+  if (build instanceof YAMLMap && build.items?.length === 0) {
+    composeData.deleteIn(['services', 'grafana', 'build']);
+  }
+
+  const volumes = composeData.getIn(['services', 'grafana', 'volumes']);
+  if (volumes instanceof YAMLSeq && volumes.items.length === 0) {
+    composeData.deleteIn(['services', 'grafana', 'volumes']);
+  }
+
+  composeData.addIn(['services', 'grafana', 'extends'], {
+    file: '.config/docker-compose-base.yaml',
+    service: 'grafana',
+  });
+
+  context.updateFile('./docker-compose.yaml', stringify(composeData, { lineWidth: 120, singleQuote: true }));


same here, some comments explaining what's going on would help reading this

…o extend from .config

…env and tidy logic

…igrations list

…to preserve comments

…ted to volumes

…migration

grafana-plugins-platform-bot · 2025-05-05T08:33:15Z

🚀 PR was released in @grafana/[email protected], @grafana/[email protected], @grafana/[email protected], @grafana/[email protected], @grafana/[email protected], @libs/[email protected] 🚀

jackw added create-plugin related to the create-plugin tool patch Increment the patch version when merged release Create a release when this pr is merged labels Mar 14, 2025

jackw self-assigned this Mar 14, 2025

jackw requested a review from a team as a code owner March 14, 2025 17:26

jackw added this to Plugins Platform / Grafana Community Mar 14, 2025

jackw requested a review from oshirohugo March 14, 2025 17:26

github-project-automation bot moved this to 📬 Triage in Plugins Platform / Grafana Community Mar 14, 2025

jackw moved this from 📬 Triage to 🧑‍💻 In development in Plugins Platform / Grafana Community Mar 14, 2025

jackw force-pushed the jackw/docker-compose-migration branch from 084e33e to 236773a Compare April 10, 2025 14:42

jackw requested a review from a team as a code owner April 10, 2025 14:42

jackw requested review from andresmgot and s4kh April 10, 2025 14:42

academo reviewed Apr 11, 2025

View reviewed changes

jackw force-pushed the jackw/docker-compose-migration branch from eaeaecf to 92bf12b Compare April 15, 2025 13:00

jackw moved this from 🧑‍💻 In development to 🔬 In review in Plugins Platform / Grafana Community Apr 16, 2025

jackw force-pushed the jackw/docker-compose-migration branch 2 times, most recently from bd154dc to 39fa6a4 Compare April 17, 2025 10:35

andresmgot approved these changes Apr 25, 2025

View reviewed changes

jackw added 10 commits May 5, 2025 09:25

feat(create-plugin): introduce a migration to update docker compose t…

7bea03f

…o extend from .config

chore(create-plugin): add yaml dependency

cdef43d

build(rollup): include migrations when bundling create-plugin

cc1a6df

feat(output): add logSingleLine method

34e861a

feat(create-plugins): use output for logging migrations

c81ccc9

feat(create-plugin): compose-extend migration support for additional …

ea7a7c8

…env and tidy logic

test(create-plugin): fix printChanges migration test using output

13ad55e

feat(create-plugin): add update-grafana-compose-extend migration to m…

3ea8a6d

…igrations list

feat(compose-extend-migration): use yaml visit api to update compose …

5db53e6

…to preserve comments

feat(compores-extend-migration): add new tests and fix up issues rela…

9729483

…ted to volumes

fix(create-plugin): make sure codepaths return so typescript is happy

aacb95e

jackw force-pushed the jackw/docker-compose-migration branch from 39fa6a4 to aacb95e Compare May 5, 2025 07:27

chore(create-plugin): add comments to the 001-grafana-compose-extend …

ce41bd0

…migration

jackw enabled auto-merge (squash) May 5, 2025 08:24

jackw merged commit c793188 into main May 5, 2025
18 checks passed

jackw deleted the jackw/docker-compose-migration branch May 5, 2025 08:25

github-project-automation bot moved this from 🔬 In review to 🚀 Shipped in Plugins Platform / Grafana Community May 5, 2025

grafana-plugins-platform-bot bot added the released This issue/pull request has been released. label May 5, 2025

jackw mentioned this pull request Jun 12, 2025

Chore: Add cursor rules to repo #1884

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Create Plugin: Add docker-compose migration for extending from .config #1621

Create Plugin: Add docker-compose migration for extending from .config #1621

Uh oh!

jackw commented Mar 14, 2025 •

edited by grafana-plugins-platform-bot bot

Loading

Uh oh!

github-actions bot commented Mar 14, 2025 •

edited

Loading

Uh oh!

academo Apr 11, 2025

Uh oh!

jackw Apr 15, 2025

Uh oh!

andresmgot left a comment

Uh oh!

andresmgot Apr 25, 2025

Uh oh!

andresmgot Apr 25, 2025

Uh oh!

Uh oh!

grafana-plugins-platform-bot bot commented May 5, 2025

Uh oh!

Uh oh!

Create Plugin: Add docker-compose migration for extending from .config #1621

Create Plugin: Add docker-compose migration for extending from .config #1621

Uh oh!

Conversation

jackw commented Mar 14, 2025 • edited by grafana-plugins-platform-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

academo Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

jackw Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

andresmgot left a comment

Choose a reason for hiding this comment

Uh oh!

andresmgot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

andresmgot Apr 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

grafana-plugins-platform-bot bot commented May 5, 2025

Uh oh!

Uh oh!

jackw commented Mar 14, 2025 •

edited by grafana-plugins-platform-bot bot

Loading

github-actions bot commented Mar 14, 2025 •

edited

Loading