.all-contributorsrc

@@ -346,6 +346,15 @@
         "test",
         "code"
       ]
+    },
+    {
+      "login": "juanicabanas",
+      "name": "Juan Cabanas",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11707172?v=4",
+      "profile": "https://github.com/juanicabanas",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7

.github/workflows/ci.yml

@@ -195,12 +195,12 @@ jobs:
           range=$(jq -r .dependencies.grafanaDependency < ${{ matrix.workingDir }}/src/plugin.json)
           # Use node-semver to get the min version of the range
           min_version=$(node -e "console.log(require('semver').minVersion('${range}')?.toString())")
-          echo "::set-output name=MIN_VERSION::$min_version"
           export MIN_VERSION=$min_version
+          echo "MIN_VERSION=${MIN_VERSION}" >> $GITHUB_OUTPUT
 
       - name: Start grafana server for e2e tests (${{ steps.min-version.outputs.MIN_VERSION }})
         run: |
-          docker compose pull 
+          docker compose pull
           ANONYMOUS_AUTH_ENABLED=false GRAFANA_VERSION=${{ steps.min-version.outputs.MIN_VERSION }} docker compose build --no-cache
           docker compose up -d
         working-directory: ./${{ matrix.workingDir }}
@@ -280,6 +280,7 @@ jobs:
         uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@main
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+          retention-days: 7
 
   release:
     runs-on: ubuntu-latest

.github/workflows/playwright.yml

@@ -69,9 +69,8 @@ jobs:
           password: ${{ env.DOCKERHUB_PASSWORD }}
 
       - name: Start Grafana
+        working-directory: ./packages/plugin-e2e
         run: |
-          cd packages/plugin-e2e
-          docker compose pull
           ANONYMOUS_AUTH_ENABLED=false GRAFANA_IMAGE=${{ matrix.GRAFANA_IMAGE.NAME }} GRAFANA_VERSION=${{ matrix.GRAFANA_IMAGE.VERSION }} docker compose up -d
 
       - name: Wait for grafana server
@@ -101,3 +100,4 @@ jobs:
         uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@main
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
+          retention-days: 7

.github/workflows/stale-branches.yml

@@ -0,0 +1,19 @@
+name: Stale Branches
+
+on:
+  schedule:
+    - cron: '0 11 * * 1-5'
+
+permissions:
+  issues: write
+  contents: write
+
+jobs:
+  stale_branches:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Stale Branches
+      uses: crs-k/stale-branches@v7.0.0
+      with:
+        dry-run: true
+        pr-check: true

CHANGELOG.md

@@ -1,3 +1,48 @@
+# (Thu Mar 13 2025)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Juan Cabanas ([@juanicabanas](https://github.com/juanicabanas)), for all your work!
+
+#### 🚀 Enhancement
+
+- Docs: Externally shared dashboard datasource plugin support [#1496](https://github.com/grafana/plugin-tools/pull/1496) ([@juanicabanas](https://github.com/juanicabanas))
+- `@grafana/create-plugin@5.19.0`, `@grafana/plugin-e2e@1.19.0`, `@grafana/plugin-types-bundler@0.3.0`, `@grafana/sign-plugin@3.1.0`
+  - Feature: Consistent CLI output [#1597](https://github.com/grafana/plugin-tools/pull/1597) ([@jackw](https://github.com/jackw))
+
+#### Authors: 2
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Juan Cabanas ([@juanicabanas](https://github.com/juanicabanas))
+
+---
+
+# (Fri Mar 07 2025)
+
+#### 🐛 Bug Fix
+
+- `@grafana/create-plugin@5.18.5`
+  - Create Plugin: Fix timeouts with canary e2e tests [#1606](https://github.com/grafana/plugin-tools/pull/1606) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# (Mon Mar 03 2025)
+
+#### 🐛 Bug Fix
+
+- `@grafana/create-plugin@5.18.4`
+  - Create Plugin: Externalise unstable entrypoints [#1580](https://github.com/grafana/plugin-tools/pull/1580) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # (Tue Feb 25 2025)
 
 #### 🐛 Bug Fix

README.md

@@ -96,6 +96,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/jalevin"><img src="https://avatars.githubusercontent.com/u/1669620?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jeff Levin</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=jalevin" title="Documentation">📖</a> <a href="https://github.com/grafana/plugin-tools/commits?author=jalevin" title="Code">💻</a></td>
     <td align="center"><a href="http://matyax.com/"><img src="https://avatars.githubusercontent.com/u/1069378?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matias Chomicki</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=matyax" title="Documentation">📖</a></td>
     <td align="center"><a href="http://www.hugohaggmark.com/"><img src="https://avatars.githubusercontent.com/u/562238?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hugo Häggmark</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Documentation">📖</a> <a href="#infra-hugohaggmark" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Tests">⚠️</a> <a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/juanicabanas"><img src="https://avatars.githubusercontent.com/u/11707172?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Juan Cabanas</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=juanicabanas" title="Documentation">📖</a></td>
   </tr>
 </table>
 

docusaurus/docs/get-started/set-up-development-environment.mdx

@@ -118,7 +118,7 @@ The CI (`ci.yml`) workflow is designed to lint, type check, and build the fronte
 
 ### The release workflow
 
-The release (`release.yml`) workflow is designed to build, test, package and sign your plugin whenever you're ready to release a new version. This automates the process of creating releases in GitHub and provides instructions for submitting the plugin to the Grafana plugin catalog.
+To learn how to automate the release process and set up the release workflow, refer to our documentation on [Automate packaging and signing with GitHub CI](../publish-a-plugin/build-automation).
 
 :::warning
 

docusaurus/docs/how-to-guides/data-source-plugins/add-migration-handler-for-backend.md

@@ -20,7 +20,7 @@ To ensure compatibility and maintain seamless performance, query migration handl
 
 Depending on the approach you take for performing [one of the steps](#step-5-use-migration-code-from-the-frontend-using-experimental-apis) in this guide, you may need to fulfill certain prerequisites. These prerequisites are:
 
-1. Grafana must be configured to run data sources as standalone API servers, a behavior which is behind the feature flag [grafanaAPIServerWithExperimentalAPIs](https://github.com/grafana/grafana/blob/3457f219be1c8bce99f713d7a907ee339ef38229/pkg/services/featuremgmt/registry.go#L519).
+1. Grafana must be configured to run data sources as standalone API servers, a behavior which is behind the feature flag [grafanaAPIServerWithExperimentalAPIs](https://github.com/grafana/grafana/blob/7773c658bb3280f0432fc9742109f8eb324c83a3/pkg/services/featuremgmt/registry.go#L474).
 1. The plugin must be run on a Grafana version 11.4 or later.
 
 More information about these prerequisites is found in [step 5](#step-5-use-migration-code-from-the-frontend-using-experimental-apis), but if your plugin can't adhere to these requirements, there is an [alternative approach](#step-5-alternative-run-migrations-using-legacy-apis) using existing APIs.
@@ -156,7 +156,7 @@ func (d *Datasource) query(ctx context.Context, pCtx backend.PluginContext, quer
 
 :::note
 
-This feature depends on the feature flag [grafanaAPIServerWithExperimentalAPIs](https://github.com/grafana/grafana/blob/build-go-fast/pkg/services/featuremgmt/registry.go#L528). It also requires the package **@grafana/runtime > 11.4** (still experimental functionality). If your plugin implements this feature, bump its **grafanaDepencency to ">=11.4.0"**. If your plugin can't adhere to these requirements, refer to [Run migrations using legacy APIs](#step-5-alternative-run-migrations-using-legacy-apis).
+This feature depends on the feature flag [grafanaAPIServerWithExperimentalAPIs](https://github.com/grafana/grafana/blob/7773c658bb3280f0432fc9742109f8eb324c83a3/pkg/services/featuremgmt/registry.go#L474). It also requires the package **@grafana/runtime > 11.4** (still experimental functionality). If your plugin implements this feature, bump its **grafanaDepencency to ">=11.4.0"**. If your plugin can't adhere to these requirements, refer to [Run migrations using legacy APIs](#step-5-alternative-run-migrations-using-legacy-apis).
 
 :::
 

docusaurus/docs/how-to-guides/data-source-plugins/add-support-for-externally-shared-dashboards.md

@@ -0,0 +1,61 @@
+---
+id: add-support-for-externally-shared-dashboards
+title: Add support for externally shared dashboards
+description: How to add support for externally share dashboards (previously called Public dashboards).
+keywords:
+  - grafana
+  - plugins
+  - plugin
+  - externally shared dashboards
+  - public dashboards
+  - data source
+  - datasource
+---
+
+[Externally shared dashboards](https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/shared-dashboards/#externally-shared-dashboards) (previously called Public dashboards) allow Grafana users to share access to their dashboards with anyone, without needing to add them to their Grafana organization as a user. When a dashboard is accessed in this way, it retrieves the query from the backend, instead of receiving it from the frontend. This is to avoid exposing sensitive data and performing unauthorized queries.
+
+Because of this, it's necessary to not pass any frontend-transformed body to the request, as it won't be used in the externally shared dashboard panel request.
+
+:::note
+
+Frontend data sources are not compatible with externally shared dashboards.
+To convert a frontend data source plugin into a backend plugin, refer to
+[convert a frontend data source to backend](./convert-a-frontend-datasource-to-backend).
+
+:::
+
+## Support externally shared dashboards in your data source plugin
+
+To make your data source plugin work in an externally shared dashboard scope, follow these steps:
+
+1.  Extend your DataSource class from `DataSourceWithBackend`
+
+    ```ts
+    export class MyDataSourceClass extends DataSourceWithBackend<TQuery, TOptions> {
+      // your logic
+    }
+    ```
+
+2.  Implement the `query` method with your customized code, if necessary. Don't transform the request body if this will change the backend query response (targets property). This body won't be passed as argument when calling the shared externally dashboard endpoint.
+
+    Then, call `super.query(request)`.
+    This is where the externally shared dashboard endpoint is called.
+
+          ```ts
+        export class MyDataSourceClass extends DataSourceWithBackend<TQuery, TOptions> {
+
+           query(request: DataQueryRequest<TQuery>): Observable<DataQueryResponse> {
+             // your logic
+             return super.query(request).pipe(
+                map((response) => {
+                    // your logic
+                })
+             );
+           }
+        }
+
+3.  Add `"backend": true` to your `plugin.json`
+
+    ```json title="src/plugin.json"
+    "backend": true
+    ```

docusaurus/docs/how-to-guides/data-source-plugins/add-support-for-variables.md

@@ -203,15 +203,15 @@ That's it! You can now try out the plugin by adding a [query variable](https://g
 
 To interpolate template variables, you need to import the `getTemplateSrv()` function from the `@grafana/runtime` package:
 
-```
+```ts
 import { getTemplateSrv } from '@grafana/runtime';
 ```
 
 The `getTemplateSrv()` function returns an instance of `TemplateSrv` which provides methods for working with template variables. The most important one, `replace()`, accepts a string containing variables as input and returns an interpolated string, where the variables have been replaced with the values that the users have selected.
 
 For example, if you have a variable called `instance`, the following code replaces the variable with its corresponding value:
 
-```
+```ts
 getTemplateSrv().replace("I'd like $instance, please!");
 
 // I'd like server-1, please!
@@ -234,16 +234,16 @@ In the previous example, the variables only had one value, `server-1`. However,
 
 For example, which of these different formats would suit your use case?
 
-```
+```ts
 {server-1, server-2, server-3} (Graphite)
 ["server-1", "server-2", "server-3"] (JSON)
 ("server-1" OR "server-2" OR "server-3") (Lucene)
 ```
 
 Fortunately, the `replace()` method lets you pass a third argument to allow you to choose from a set of predefined formats, such as the CSV format:
 
-```
-getTemplateSrv().replace("I'd like $instance, please!", {}, "csv");
+```ts
+getTemplateSrv().replace("I'd like $instance, please!", {}, 'csv');
 
 // I'd like server-1, server-2, server-3, please!
 ```
@@ -262,7 +262,7 @@ After reviewing the advanced variable format options, you may find that you want
 
 You can pass an interpolation function to `replace()` instead of a string as the third argument. The following example uses a custom formatter function to add an `and` before the last element:
 
-```
+```ts
 const formatter = (value: string | string[]): string => {
   if (typeof value == 'string') {
     return value;
@@ -289,7 +289,7 @@ There may be a case where you want to use a variable outside of a template. For
 
 This helper function uses the `replace()` method to return the values as an array:
 
-```
+```ts
 function getValuesForVariable(name: string): string[] {
   const values: string[] = [];
 
@@ -307,7 +307,7 @@ function getValuesForVariable(name: string): string[] {
 
   return values;
 }
-const instances = getValuesForVariable("instance");
+const instances = getValuesForVariable('instance');
 
 for (var instance of instances) {
   console.log(instance);
@@ -320,7 +320,7 @@ for (var instance of instances) {
 
 You can even go a step further and create an object that neatly contains all variables and their values:
 
-```
+```ts
 function getAllVariables(): Record<string, string[]> {
   const entries = getTemplateSrv()
     .getVariables()

docusaurus/docs/how-to-guides/data-source-plugins/convert-a-frontend-datasource-to-backend.md

@@ -17,7 +17,7 @@ To convert the frontend data source, we recommend scaffolding a new backend data
 
 ## Why
 
-There are multiple features available only in backend plugins, such as Grafana Alerting or Recorded queries. See the use cases for implementing a backend plugin in the [backend plugins introduction](../../key-concepts/backend-plugins/#use-cases-for-implementing-a-backend-plugin).
+There are multiple features available only in backend plugins, such as Grafana Alerting, Recorded queries, or externally shared dashboards (previously called Public dashboards). Refer to the use cases for implementing a backend plugin in the [backend plugins introduction](../../key-concepts/backend-plugins/#use-cases-for-implementing-a-backend-plugin).
 
 ## Before you begin
 

docusaurus/docs/migration-guides/update-from-grafana-versions/v11.5.x-v11.6.x.md

@@ -0,0 +1,28 @@
+---
+id: migrate-11_5_x-to-11_6_x
+title: 11.5.x to 11.6.x
+sidebar_position: 2
+description: How to migrate plugins from Grafana version 11.5.x to 11.6.x.
+keywords:
+  - grafana
+  - plugins
+  - plugin
+  - upgrading
+  - updating
+  - migration
+---
+
+# Migrate plugins from Grafana version 11.5.x to 11.6.x
+
+Follow these instructions to migrate plugins from Grafana version 11.5.x to 11.6.x.
+
+## usePluginComponents options changed in @grafana/runtime
+
+We updated the hook's options TypeScript type due to accidentally using an incorrect deprecated type. This change was delivered to the core `grafana` repo with [PR 100949](https://github.com/grafana/grafana/pull/100949).
+
+**Recommended actions:**
+
+- Remove the `context` property when calling the `usePluginComponents`. The `context` should be passed to each Component as props.
+
+**Please note:**
+This is a build time error and won't have any effect during the runtime of Grafana.