@grafana/create-plugin 5.15.0-canary.1504.eae6df1.0 → 5.15.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# v5.15.0 (Tue Feb 04 2025)
+
+#### 🐛 Bug Fix
+
+- chore(deps): update dependency @grafana/plugin-e2e to v1.17.1 [#1507](https://github.com/grafana/plugin-tools/pull/1507) ([@renovate[bot]](https://github.com/renovate[bot]))
+
+#### Authors: 1
+
+- [@renovate[bot]](https://github.com/renovate[bot])
+
+---
+
+# v5.14.1 (Fri Jan 31 2025)
+
+#### 🐛 Bug Fix
+
+- CreatePlugin: Update that panel plugin template uses new panel edit options [#1502](https://github.com/grafana/plugin-tools/pull/1502) ([@mckn](https://github.com/mckn))
+- chore(deps): update dependency @grafana/e2e-selectors to v11.5.0 [#1492](https://github.com/grafana/plugin-tools/pull/1492) ([@renovate[bot]](https://github.com/renovate[bot]) [@tolzhabayev](https://github.com/tolzhabayev))
+
+#### Authors: 3
+
+- [@renovate[bot]](https://github.com/renovate[bot])
+- Marcus Andersson ([@mckn](https://github.com/mckn))
+- Timur Olzhabayev ([@tolzhabayev](https://github.com/tolzhabayev))
+
+---
+
 # v5.14.0 (Tue Jan 28 2025)
 
 #### 🚀 Enhancement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.15.0-canary.1504.eae6df1.0",
+  "version": "5.15.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "eae6df1d67d285e7122972f8d52bf7b9ccf30704"
+  "gitHead": "9d8671c55a6c3508807e8721bae5ef055beb1ab7"
 }

package/templates/_partials/frontend-getting-started.md

@@ -34,15 +34,12 @@
    {{ packageManagerName }} run server
    ```
 
-6. Run the E2E tests (using Playwright)
+6. Run the E2E tests (using Cypress)
 
    ```bash
    # Spins up a Grafana instance first that we tests against
    {{ packageManagerName }} run server
 
-   # If you wish to start a certain Grafana version
-   GRAFANA_VERSION=11.3.0 {{ packageManagerName }} run server
-
    # Starts the tests
    {{ packageManagerName }} run e2e
    ```

package/templates/common/_package.json

@@ -21,7 +21,7 @@
 {{#if useCypress}}    "@grafana/e2e": "^11.0.7",
     "@grafana/e2e-selectors": "^11.5.0",{{/if}}
     "@grafana/eslint-config": "^8.0.0",{{#if usePlaywright}}
-    "@grafana/plugin-e2e": "^1.13.1",{{/if}}
+    "@grafana/plugin-e2e": "^1.17.1",{{/if}}
     "@grafana/tsconfig": "^2.0.0",{{#if usePlaywright}}
     "@playwright/test": "^1.41.2",{{/if}}
     "@stylistic/eslint-plugin-ts": "^2.9.0",

package/templates/common/playwright.config

@@ -21,8 +21,6 @@ export default defineConfig<PluginOptions>({
   forbidOnly: !!process.env.CI,
   /* Retry on CI only */
   retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : undefined,
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: 'html',
   /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */

package/templates/github/workflows/ci.yml

@@ -11,10 +11,7 @@ on:
       - master
       - main
 
-permissions:
-  contents: write
-  id-token: write
-  pull-requests: write
+permissions: read-all
 
 jobs:
   build:
@@ -206,14 +203,6 @@ jobs:
         id: run-tests
         run: {{ packageManagerName }} run e2e
 
-      - name: Upload e2e test summary
-        uses: grafana/plugin-actions/playwright-gh-pages/upload-report-artifacts@main
-        if: $\{{ always() && !cancelled() }}
-        with:
-          upload-report: false
-          github-token: $\{{ secrets.GITHUB_TOKEN }}
-          test-outcome: $\{{ steps.run-tests.outcome }}
-
       - name: Docker logs
         if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
         run: |
@@ -222,23 +211,20 @@ jobs:
       - name: Stop grafana docker
         run: docker compose down
 
-      # Uncomment this step to upload the server log to Github artifacts. Remember Github artifacts are public on the Internet if the repository is public.
-      # - name: Upload server log
+      - name: Upload server log
+        uses: actions/upload-artifact@v4
+        if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
+        with:
+          name: $\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}-server-log
+          path: grafana-server.log
+          retention-days: 5
+
+      # Uncomment this step to upload the Playwright report to Github artifacts.
+      # If your repository is public, the report will be public on the Internet so beware not to expose sensitive information.
+      # - name: Upload artifacts
       #   uses: actions/upload-artifact@v4
       #   if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
       #   with:
-      #     name: $\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}-server-log
-      #     path: grafana-server.log
+      #     name: playwright-report-$\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}
+      #     path: playwright-report/
       #     retention-days: 5
-
-  publish-report:
-    if: $\{{ always() && !cancelled() }}
-    needs: [playwright-tests]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Publish report
-        uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@main
-        with:
-          github-token: $\{{ secrets.GITHUB_TOKEN }}
-

package/templates/panel/tests/panel.spec.ts

@@ -1,4 +1,3 @@
-import * as semver from 'semver';
 import { test, expect } from '@grafana/plugin-e2e';
 
 test('should display "No data" in case panel data is empty', async ({
@@ -22,23 +21,15 @@ test('should display circle when data is passed to the panel', async ({
 });
 
 test('should display series counter when "Show series counter" option is enabled', async ({
-  panelEditPage,
-  readProvisionedDataSource,
+  gotoPanelEditPage,
+  readProvisionedDashboard,
   page,
-  selectors,
-  grafanaVersion
 }) => {
-  const ds = await readProvisionedDataSource({ fileName: 'datasources.yml' });
-  await panelEditPage.datasource.set(ds.name);
-  await panelEditPage.setVisualization('{{titleCase pluginName }}');
-  await panelEditPage.collapseSection('{{titleCase pluginName }}');
-  await expect(page.getByTestId('simple-panel-circle')).toBeVisible();
-  const seriesCounterLabel = panelEditPage.getByGrafanaSelector(
-    selectors.components.PanelEditor.OptionsPane.fieldLabel('{{titleCase pluginName }} Show series counter')
-  );
-  const switchField = semver.gte(grafanaVersion, '11.4.0')
-    ? seriesCounterLabel.getByRole('switch')
-    : seriesCounterLabel.getByLabel('Toggle switch');
-  await switchField.click({ force: true });
+  const dashboard = await readProvisionedDashboard({ fileName: 'dashboard.json' });
+  const panelEditPage = await gotoPanelEditPage({ dashboard, id: '1' });
+  const options = panelEditPage.getCustomOptions('{{titleCase pluginName }}');
+  const showSeriesCounter = options.getSwitch('Show series counter');
+
+  await showSeriesCounter.check();
   await expect(page.getByTestId('simple-panel-series-counter')).toBeVisible();
 });