feat: switch e2e-version to use nightly image instead of grafana-dev (#216)

* remove get-dev-image-tag.js and update index.js to handle nightly image logic

* Update e2e-version/index.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update e2e-version/index.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: use getBooleanInput OR for deprecated alias, add nightly image tests

* chore: add deprecationMessage to skip-grafana-dev-image, add braces to test ifs

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: sunker

e2e-version/README.md

@@ -4,9 +4,11 @@ This Action resolves what Grafana image names and versions to use when E2E testi
 
 ## Inputs
 
-### `skip-grafana-dev-image`
+### `skip-grafana-nightly-image`
 
-By default, this actions resolves an image for the latest build of the main branch in Grafana. If you don't want to include the `grafana-dev` image in your test matrix, you can opt-out on it by setting the `skip-grafana-dev-image` to `true`.
+By default, this action includes the `grafana-enterprise:nightly` image in the test matrix. To exclude it, set `skip-grafana-nightly-image` to `true`.
+
+> **Deprecated:** The old `skip-grafana-dev-image` input is still accepted as an alias but will be removed in a future release.
 
 ### `limit`
 
@@ -17,7 +19,7 @@ The maximum number of versions to resolve. Default is 6, 0 means no limit.
 The action supports two modes.
 
 **plugin-grafana-dependency (default)**
-The will return the most recent grafana-dev image and all the latest patch release of every minor version of Grafana Enterprise that satisfies the range specified in the [dependencies.grafanaDependency](https://grafana.com/developers/plugin-tools/reference/plugin-json#properties-1) property in plugin.json. This requires the plugin.json file to be placed in the `<root>/src` directory. To avoid starting too many jobs, to output will be capped 6 versions.
+This will return the `grafana-enterprise:nightly` image and all the latest patch releases of every minor version of Grafana Enterprise that satisfies the range specified in the [dependencies.grafanaDependency](https://grafana.com/developers/plugin-tools/reference/plugin-json#properties-1) property in plugin.json. This requires the plugin.json file to be placed in the `<root>/src` directory. To avoid starting too many jobs, the output will be capped at 6 versions.
 
 ### Example
 
@@ -26,8 +28,8 @@ At the time of writing, the most recent release of Grafana is 10.3.1. If the plu
 ```json
 [
   {
-    "name": "grafana-dev",
-    "version": "10.4.0-157931"
+    "name": "grafana-enterprise",
+    "version": "nightly"
   },
   {
     "name": "grafana-enterprise",
@@ -55,7 +57,7 @@ At the time of writing, the most recent release of Grafana is 10.3.1. If the plu
 Please note that the output changes as new versions of Grafana are being released.
 
 **version-support-policy**
-Except for resolving the most recent grafana-dev image, this will resolve versions according to Grafana's plugin compatibility support policy. Specifically, it retrieves the latest patch release for each minor version within the current major version of Grafana. Additionally, it includes the most recent release for the latest minor version of the previous major Grafana version.```
+Except for including the `grafana-enterprise:nightly` image, this will resolve versions according to Grafana's plugin compatibility support policy. Specifically, it retrieves the latest patch release for each minor version within the current major version of Grafana. Additionally, it includes the most recent release for the latest minor version of the previous major Grafana version.
 
 ### Example
 
@@ -64,8 +66,8 @@ At the time of writing, the most recent release of Grafana is 10.2.2. The output
 ```json
 [
   {
-    "name": "grafana-dev",
-    "version": "10.4.0-157931"
+    "name": "grafana-enterprise",
+    "version": "nightly"
   },
   {
     "name": "grafana-enterprise",

e2e-version/action.yml

@@ -2,10 +2,16 @@ name: 'Grafana E2E version resolver'
 description: 'Resolve Grafana versions for use in E2E tests'
 
 inputs:
+  skip-grafana-nightly-image:
+    default: false
+    required: false
+    description: 'Optionally, you can skip the Grafana nightly image'
+    type: boolean
   skip-grafana-dev-image:
     default: false
     required: false
-    description: 'Optionally, you can skip the Grafana dev image'
+    description: 'Deprecated: use skip-grafana-nightly-image instead'
+    deprecationMessage: 'skip-grafana-dev-image is deprecated, use skip-grafana-nightly-image instead'
     type: boolean
   skip-grafana-react-19-preview-image:
     required: false

e2e-version/dist/index.js

@@ -1,9 +1,9 @@
 const core = require('@actions/core');
 const semver = require('semver');
-const getDevImageTag = require('./get-dev-image-tag');
 const fs = require('fs/promises');
 const path = require('path');
 
+const SkipGrafanaNightlyImageInput = 'skip-grafana-nightly-image';
 const SkipGrafanaDevImageInput = 'skip-grafana-dev-image';
 const SkipGrafanaReact19PreviewImageInput = 'skip-grafana-react-19-preview-image';
 const VersionResolverTypeInput = 'version-resolver-type';
@@ -18,7 +18,9 @@ const VersionResolverTypes = {
 
 async function run() {
   try {
-    const skipGrafanaDevImage = core.getBooleanInput(SkipGrafanaDevImageInput);
+    // skip-grafana-dev-image is a deprecated alias for skip-grafana-nightly-image
+    const skipGrafanaNightlyImage =
+      core.getBooleanInput(SkipGrafanaNightlyImageInput) || core.getBooleanInput(SkipGrafanaDevImageInput);
 
     // Determine default for React image based on repository owner
     // Include by default for Grafana org repositories, skip for others
@@ -83,7 +85,8 @@ async function run() {
 
     if (limit !== 0 && versionResolverType === VersionResolverTypes.PluginGrafanaDependency && versions.length !== 0) {
       // limit the number of versions to avoid starting too many jobs
-      versions = evenlyPickVersions(versions, skipGrafanaDevImage ? limit : limit - 1);
+      const stableVersionLimit = Math.max(0, skipGrafanaNightlyImage ? limit : limit - 1);
+      versions = evenlyPickVersions(versions, stableVersionLimit);
     }
 
     // official grafana-enterprise image
@@ -92,12 +95,8 @@ async function run() {
       version,
     }));
 
-    if (!skipGrafanaDevImage) {
-      // get the most recent grafana-dev image
-      const tag = await getDevImageTag({ core });
-      if (tag) {
-        images.unshift({ name: 'grafana-dev', version: tag });
-      }
+    if (!skipGrafanaNightlyImage) {
+      images.unshift({ name: 'grafana-enterprise', version: 'nightly' });
     }
 
     if (!skipGrafanaReact19PreviewImage) {

e2e-version/get-dev-image-tag.js

@@ -48,9 +48,54 @@ describe('plugin-grafana-dependency mode', () => {
       if (name === GrafanaDependencyInput) {
         return t.grafanaDependency;
       }
+      if (name === 'limit') {
+        return '6';
+      }
+      if (name === 'skip-grafana-nightly-image') {
+        return 'true';
+      }
+      return '';
     });
     getBooleanInput.mockReturnValue(true);
     const images = await run();
     expect(images.map((i) => i.version)).toEqual(t.expectedVersions);
   });
 });
+
+describe('nightly image', () => {
+  it('is included by default', async () => {
+    getInput.mockImplementation((name) => {
+      if (name === VersionResolverTypeInput) { return VersionResolverTypes.PluginGrafanaDependency; }
+      if (name === GrafanaDependencyInput) { return '>=10.4.4'; }
+      if (name === 'limit') { return '6'; }
+      return '';
+    });
+    getBooleanInput.mockReturnValue(false);
+    const images = await run();
+    expect(images[0]).toEqual({ name: 'grafana-enterprise', version: 'nightly' });
+  });
+
+  it('is skipped when skip-grafana-nightly-image is true', async () => {
+    getInput.mockImplementation((name) => {
+      if (name === VersionResolverTypeInput) { return VersionResolverTypes.PluginGrafanaDependency; }
+      if (name === GrafanaDependencyInput) { return '>=10.4.4'; }
+      if (name === 'limit') { return '6'; }
+      return '';
+    });
+    getBooleanInput.mockImplementation((name) => name === 'skip-grafana-nightly-image');
+    const images = await run();
+    expect(images.every((i) => i.version !== 'nightly')).toBe(true);
+  });
+
+  it('is skipped when deprecated skip-grafana-dev-image is true', async () => {
+    getInput.mockImplementation((name) => {
+      if (name === VersionResolverTypeInput) { return VersionResolverTypes.PluginGrafanaDependency; }
+      if (name === GrafanaDependencyInput) { return '>=10.4.4'; }
+      if (name === 'limit') { return '6'; }
+      return '';
+    });
+    getBooleanInput.mockImplementation((name) => name === 'skip-grafana-dev-image');
+    const images = await run();
+    expect(images.every((i) => i.version !== 'nightly')).toBe(true);
+  });
+});