@grafana/sign-plugin 1.1.0-canary.331.cc6e77d.0 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v1.1.0 (Mon Aug 07 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Yulia Shanyrova ([@Ukochka](https://github.com/Ukochka)), for all your work!
+
+#### 🚀 Enhancement
+
+- sign-plugin: GRAFANA_ACESS_POLICY_TOKEN has been added instead of GRAFANA_API_KEY [#331](https://github.com/grafana/plugin-tools/pull/331) ([@Ukochka](https://github.com/Ukochka))
+
+#### Authors: 1
+
+- Yulia Shanyrova ([@Ukochka](https://github.com/Ukochka))
+
+---
+
 # v1.0.3 (Mon Jul 10 2023)
 
 #### 🐛 Bug Fix

package/README.md

@@ -26,17 +26,17 @@ Please refer to [Signing plugins documentation](https://grafana.com/docs/grafana
 
 ### Sign a public plugin
 
-In your plugin directory, sign the plugin with your Grafana API key. Grafana sign-plugin creates a MANIFEST.txt file in the dist directory of your plugin.
+In your plugin directory, sign the plugin with your Grafana access policy token. Grafana sign-plugin creates a MANIFEST.txt file in the dist directory of your plugin.
 
 ```bash
-export GRAFANA_API_KEY=<YOUR_API_KEY>
+export GRAFANA_ACCESS_POLICY_TOKEN=<YOUR_GRAFANA_ACCESS_POLICY_TOKEN>
 npx @grafana/sign-plugin@latest
 ```
 
 If the plugin distribution directory differs from the default `dist`, specify the path to use with the `--distDir` flag.
 
 ```bash
-export GRAFANA_API_KEY=<YOUR_API_KEY>
+export GRAFANA_ACCESS_POLICY_TOKEN=<YOUR_GRAFANA_ACCESS_POLICY_TOKEN>
 npx @grafana/sign-plugin@latest --distDir path/to/directory
 ```
 

package/dist/utils/manifest.js

@@ -218,13 +218,11 @@ function signManifest(manifest) {
                 case 0:
                     GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
                     GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
-                    if (!GRAFANA_ACCESS_POLICY_TOKEN) {
-                        if (!GRAFANA_API_KEY) {
-                            throw new Error('You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-an-api-key for instructions.');
-                        }
-                        else {
-                            console.warn("\u001B[33m%s\u001B[0m", 'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin');
-                        }
+                    if (!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
+                        throw new Error('You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-a-token for instructions.');
+                    }
+                    if (GRAFANA_API_KEY) {
+                        console.warn("\u001B[33m%s\u001B[0m", 'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin');
                     }
                     GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';
                     url = GRAFANA_COM_URL + '/plugins/ci/sign';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/sign-plugin",
-  "version": "1.1.0-canary.331.cc6e77d.0",
+  "version": "1.1.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/sign-plugin",
@@ -40,5 +40,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "cc6e77d2b730dfe44c297e567dbf536c6643e4c7"
+  "gitHead": "85bae17e8637567be338933541d02d811d314251"
 }

package/src/utils/manifest.ts

@@ -78,15 +78,13 @@ export async function signManifest(manifest: ManifestInfo): Promise<string> {
   const GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
   const GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
 
-  if(!GRAFANA_ACCESS_POLICY_TOKEN) {
-    if (!GRAFANA_API_KEY) {
-      throw new Error(
-        'You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-an-api-key for instructions.'
-      );
-    }
-    else {
-      console.warn(`\x1b[33m%s\x1b[0m`,'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin')
-    }
+  if(!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
+    throw new Error(
+      'You must create a GRAFANA_ACCESS_POLICY_TOKEN env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-a-token for instructions.'
+    );
+  }
+  if (GRAFANA_API_KEY) {
+    console.warn(`\x1b[33m%s\x1b[0m`,'The usage of GRAFANA_API_KEY is deprecated, please consider using GRAFANA_ACCESS_POLICY_TOKEN instead. For more info visit https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/sign-a-plugin')
   }
 
   const GRAFANA_COM_URL = process.env.GRAFANA_COM_URL || 'https://grafana.com/api';