@grafana/create-plugin 4.7.0 → 4.7.1-canary.890.5d6b0d7.0

package/CONTRIBUTING.md

@@ -21,7 +21,9 @@ npm install
 
 ### Technologies
 
-- [**`Plop`**](https://github.com/plopjs/plop) - we are using Plop for the CLI tool and for scaffolding
+- [**`minimist`**](https://www.npmjs.com/package/minimist) - for parsing cmd line args
+- [**`enquirer`**](https://www.npmjs.com/package/enquirer) - for prompting users for information
+- [**`handlebars`**](https://www.npmjs.com/package/handlebars) - for file templates
 
 ### Folder structure
 
@@ -32,7 +34,7 @@ npm install
 │   ├── bin // the entrypoint file
 │   ├── commands // Code that runs commands
 │   └── utils // Utilities used by commands
-└── templates // Plop templates
+└── templates // Handlebars templates
     ├── _partials // Composable parts of a template
     ├── app // Templates specific to scaffolding an app plugin
     ├── backend // Templates specific to scaffolding backend plugin code
@@ -76,6 +78,6 @@ _Work in progress._
 
 ### Developing the templates
 
-The templates are used by Plop to scaffold Grafana plugins. Whilst they appear to be the intended filetype they are infact treated as markdown by Plop when it runs. As such we need to be mindful of syntax and to [escape particular characters](https://handlebarsjs.com/guide/expressions.html#whitespace-control) where necessary. The [github/ci.yml](./templates/github/ci/.github/workflows/ci.yml) file is a good example of this.
+The templates are used by Handlebars to scaffold Grafana plugins. Whilst they appear to be the intended filetype they are infact treated as markdown by Handlebars when it runs. As such we need to be mindful of syntax and to [escape particular characters](https://handlebarsjs.com/guide/expressions.html#whitespace-control) where necessary. The [github/ci.yml](./templates/github/ci/.github/workflows/ci.yml) file is a good example of this.
 
 Note that certain files are intentionally named differently (e.g. npmrc, package.json). This is done due to other tooling preventing the files from being packaged for NPM or breaking other tools during local development.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.7.0",
+  "version": "4.7.1-canary.890.5d6b0d7.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "b18692d9bdc211888da99627436f58b1229d88ad"
+  "gitHead": "5d6b0d7333e7d79945ae1b0b6bbed281436dd985"
 }

package/src/constants.ts

@@ -39,7 +39,7 @@ export enum PLUGIN_TYPES {
   scenes = 'scenesapp',
 }
 
-// This gets merged into variables coming from user prompts (when using Plop) or any other dynamic variables,
+// This gets merged into variables coming from user prompts (when scaffolding) or any other dynamic variables,
 // and will be available to use in the templates.
 // Example: "@grafana/ui": "{{ grafanaVersion }}"
 export const EXTRA_TEMPLATE_VARIABLES = {

package/templates/common/docker-compose.yaml

@@ -11,6 +11,7 @@ services:
       args:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
         grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }
+        development: ${DEVELOPMENT:-true}
     ports:
       - 3000:3000/tcp
 {{#if hasBackend}}

package/templates/github/ci/.github/workflows/ci.yml

@@ -11,7 +11,11 @@ on:
       - master
       - main
 
-permissions: read-all
+permissions:
+  contents: read
+{{#if_eq orgName "grafana"}}
+  id-token: write
+{{/if_eq}}
 
 jobs:
   build:
@@ -141,11 +145,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-        with:
-          sparse-checkout: |
-            provisioning
-            tests
-            .config
 
       - name: Download plugin
         if: needs.build.outputs.has-backend == 'true'
@@ -176,7 +175,7 @@ jobs:
       - name: Start Grafana
         run: |
           docker-compose pull
-          GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker-compose up -d
+          DEVELOPMENT=false GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker-compose up -d
 
       - name: Wait for Grafana to start
         uses: nev7n/wait_for_response@v1
@@ -187,7 +186,7 @@ jobs:
           interval: 500
 
       - name: Install Playwright Browsers
-        run: npx playwright install chromium --with-deps
+        run: {{ packageManagerName }} exec playwright install chromium --with-deps
 
       - name: Run Playwright tests
         id: run-tests
@@ -208,7 +207,7 @@ jobs:
           name: $\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}-server-log
           path: grafana-server.log
           retention-days: 5
-
+  
       # If your repository is public, uploading the Playwright report will make it public on the Internet.
       # Beware not to expose sensitive information.
       - name: Upload artifacts
@@ -218,3 +217,14 @@ jobs:
           name: playwright-report-$\{{ matrix.GRAFANA_IMAGE.NAME }}-v$\{{ matrix.GRAFANA_IMAGE.VERSION }}-$\{{github.run_id}}
           path: playwright-report/
           retention-days: 5
+
+{{#if_eq orgName "grafana"}}
+      # Repos in the grafana Github org can publish the report to GCS so that they can be browsed without having to download them.
+      # This will make the report public on the Internet, so beware to skip this step if the report contains sensitive information.
+      - name: Publish report to GCS
+        if: $\{{ always() && steps.run-tests.outcome == 'failure' }}
+        uses: grafana/plugin-actions/publish-report@main
+        with:
+          grafana-version: ${{ matrix.GRAFANA_IMAGE.VERSION }}
+          path: playwright-report
+{{/if_eq}}