@grafana/sign-plugin 1.0.3 → 1.1.0-canary.331.27f077a.0

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

@@ -212,21 +212,26 @@ exports.buildManifest = buildManifest;
 function signManifest(manifest) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function () {
-        var GRAFANA_API_KEY, GRAFANA_COM_URL, url, info, err_1;
+        var GRAFANA_API_KEY, GRAFANA_ACCESS_POLICY_TOKEN, GRAFANA_COM_URL, url, token, info, err_1;
         return __generator(this, function (_c) {
             switch (_c.label) {
                 case 0:
                     GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
-                    if (!GRAFANA_API_KEY) {
-                        throw new Error('You must create a GRAFANA_API_KEY env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-an-api-key for instructions.');
+                    GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
+                    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-an-api-key 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';
+                    token = GRAFANA_ACCESS_POLICY_TOKEN ? GRAFANA_ACCESS_POLICY_TOKEN : GRAFANA_API_KEY;
                     _c.label = 1;
                 case 1:
                     _c.trys.push([1, 3, , 4]);
                     return [4, (0, request_1.postData)(url, manifest, {
-                            Authorization: 'Bearer ' + GRAFANA_API_KEY
+                            Authorization: 'Bearer ' + token
                         })];
                 case 2:
                     info = _c.sent();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/sign-plugin",
-  "version": "1.0.3",
+  "version": "1.1.0-canary.331.27f077a.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/sign-plugin",
@@ -40,5 +40,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "45b14f317e18f7f76655292c01d853e5b991cb36"
+  "gitHead": "27f077a66f66e6d0f811e4c886fb1f0f0f1865dd"
 }

package/src/utils/manifest.ts

@@ -76,18 +76,24 @@ export async function buildManifest(dir: string): Promise<ManifestInfo> {
 
 export async function signManifest(manifest: ManifestInfo): Promise<string> {
   const GRAFANA_API_KEY = process.env.GRAFANA_API_KEY;
-  if (!GRAFANA_API_KEY) {
+  const GRAFANA_ACCESS_POLICY_TOKEN = process.env.GRAFANA_ACCESS_POLICY_TOKEN;
+
+  if(!GRAFANA_ACCESS_POLICY_TOKEN && !GRAFANA_API_KEY) {
     throw new Error(
-      'You must create a GRAFANA_API_KEY env variable to sign plugins. Please see: https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#generate-an-api-key for instructions.'
+      '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.'
     );
   }
+  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';
   const url = GRAFANA_COM_URL + '/plugins/ci/sign';
 
+  const token = GRAFANA_ACCESS_POLICY_TOKEN ? GRAFANA_ACCESS_POLICY_TOKEN : GRAFANA_API_KEY;
   try {
     const info = await postData(url, manifest, {
-      Authorization: 'Bearer ' + GRAFANA_API_KEY,
+      Authorization: 'Bearer ' + token,
     });
     if (info.status !== 200) {
       console.error('Error: ', info);