From 8ddf8ab6ee183b7bbafe7c52bf890659ec879bcd Mon Sep 17 00:00:00 2001 From: Timur Olzhabayev Date: Wed, 27 Jul 2022 15:19:47 +0200 Subject: [PATCH] Updating plugin packaging documentation (#52744) * Updating packaging documentation * Adding link to zipinfo manpage * Removing unx as codespell doesnt like it --- .../developers/plugins/package-a-plugin.md | 36 ++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/sources/developers/plugins/package-a-plugin.md b/docs/sources/developers/plugins/package-a-plugin.md index ca4af12fe9e..7569040074f 100644 --- a/docs/sources/developers/plugins/package-a-plugin.md +++ b/docs/sources/developers/plugins/package-a-plugin.md @@ -33,15 +33,49 @@ There are three steps needed to package a plugin: mage ``` + make sure that all the binaries are executable and have a `0755` (`-rwxr-xr-x`) permission + 1. [Sign the plugin]({{< relref "sign-a-plugin/" >}}). -1. Create a ZIP archive of the `dist` directory. +1. Rename `dist` directory to match your plugin id and create a ZIP archive ``` mv dist/ myorg-simple-panel zip myorg-simple-panel-1.0.0.zip myorg-simple-panel -r ``` +1. (Optional) Verify your plugin is packaged correctly using [zipinfo](https://linux.die.net/man/1/zipinfo). It should look like this: + +``` +zipinfo grafana-clickhouse-datasource-1.1.2.zip + +Archive: grafana-clickhouse-datasource-1.1.2.zip +Zip file size: 34324077 bytes, number of entries: 22 +drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/ +-rw-r--r-- 1654 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/CHANGELOG.md +-rw-r--r-- 11357 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/LICENSE +-rw-r--r-- 2468 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/MANIFEST.txt +-rw-r--r-- 8678 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/README.md +drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/ +-rw-r--r-- 42973 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/cluster-analysis.json +-rw-r--r-- 56759 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/data-analysis.json +-rw-r--r-- 39406 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/dashboards/query-analysis.json +-rwxr-xr-x 16469136 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_darwin_amd64 +-rwxr-xr-x 16397666 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_darwin_arm64 +-rwxr-xr-x 14942208 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_amd64 +-rwxr-xr-x 14155776 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_arm +-rwxr-xr-x 14548992 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_linux_arm64 +-rwxr-xr-x 15209472 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/gpx_clickhouse_windows_amd64.exe +drwxr-xr-x 0 bx stor 22-Mar-24 23:23 grafana-clickhouse-datasource/img/ +-rw-r--r-- 304 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/img/logo.png +-rw-r--r-- 1587 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/img/logo.svg +-rw-r--r-- 138400 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js +-rw-r--r-- 808 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js.LICENSE.txt +-rw-r--r-- 487395 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/module.js.map +-rw-r--r-- 1616 bX defN 22-Mar-24 23:23 grafana-clickhouse-datasource/plugin.json +22 files, 92516655 bytes uncompressed, 34319591 bytes compressed: 62.9% +``` + # Publish your plugin on Grafana.com The best way to share your plugin with the world is to publish it on [Grafana Plugins](https://grafana.com/plugins). By having your plugin published on Grafana.com, more users will be able to discover your plugin.