fix(build): update out-of-date dependencies and documentation and also improve makefile

fix(build): improve makefile to run different kind of commands necessary to build the plugin locally

fix(build): added typescript explicit dependency

fix(build): upgraded grafana-plugin-sdk-go module

fix(docs): add link to Grafana's how to publish plugin

fix(docs): add summary to the readme

fix(build): rename ci.yaml github action to validate-build.yaml to have a more precise meaning

fix(build): switch from master branch to main branch in the worflow_dispatch

Author: miguel91it

.github/workflows/release.yml

@@ -17,11 +17,6 @@ jobs:
         with:
           node-version: '14.x'
 
-      - name: Setup Go environment
-        uses: actions/setup-go@v2
-        with:
-          go-version: '1.17'
-
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -34,6 +29,7 @@ jobs:
           key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-yarn-
+
       - name: Cache node_modules
         id: cache-node-modules
         uses: actions/cache@v2
@@ -42,11 +38,13 @@ jobs:
           key: ${{ runner.os }}-${{ matrix.node-version }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ matrix.node-version }}-nodemodules-
+
       - name: Install dependencies
         run: yarn install --frozen-lockfile;
         if: |
           steps.cache-yarn-cache.outputs.cache-hit != 'true' ||
           steps.cache-node-modules.outputs.cache-hit != 'true'
+
       - name: Build and test frontend
         run: yarn build
 
@@ -57,18 +55,25 @@ jobs:
           then
             echo "::set-output name=has-backend::true"
           fi
+      
+      - name: Setup Go environment
+        if: steps.check-for-backend.outputs.has-backend == 'true'
+        uses: actions/setup-go@v2
+        with:
+          go-version: '1.19'
+      
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
-          version: latest
+          version: v1.14.0
           args: coverage
 
       - name: Build backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
-          version: latest
+          version: v1.14.0
           args: buildAll
 
       - name: Sign plugin
@@ -91,11 +96,13 @@ jobs:
           echo "::set-output name=archive::${GRAFANA_PLUGIN_ARTIFACT}"
           echo "::set-output name=archive-checksum::${GRAFANA_PLUGIN_ARTIFACT_CHECKSUM}"
           echo ::set-output name=github-tag::${GITHUB_REF#refs/*/}
+
       - name: Read changelog
         id: changelog
         run: |
           awk '/^## / {s++} s == 1 {print}' CHANGELOG.md > release_notes.md
           echo "::set-output name=path::release_notes.md"
+     
       - name: Check package version
         run: if [ "v${{ steps.metadata.outputs.plugin-version }}" != "${{ steps.metadata.outputs.github-tag }}" ]; then printf "\033[0;31mPlugin version doesn't match tag name\033[0m\n"; exit 1; fi
 
@@ -106,13 +113,15 @@ jobs:
           zip ${{ steps.metadata.outputs.archive }} ${{ steps.metadata.outputs.plugin-id }} -r
           md5sum ${{ steps.metadata.outputs.archive }} > ${{ steps.metadata.outputs.archive-checksum }}
           echo "::set-output name=checksum::$(cat ./${{ steps.metadata.outputs.archive-checksum }} | cut -d' ' -f1)"
+
       - name: Lint plugin
         run: |
           git clone https://github.com/grafana/plugin-validator
-          pushd ./plugin-validator/pkg/cmd/plugincheck
+          pushd ./plugin-validator/pkg/cmd/plugincheck2
           go install
           popd
-          plugincheck ${{ steps.metadata.outputs.archive }}
+          plugincheck2 ${{ steps.metadata.outputs.archive }}
+
       - name: Create release
         id: create_release
         uses: actions/create-release@v1

.github/workflows/ci.yml .github/workflows/validate-build.yml.github/workflows/ci.yml renamed to .github/workflows/validate-build.yml

@@ -1,4 +1,4 @@
-name: CI
+name: validate-build
 
 on:
   workflow_dispatch:
@@ -7,7 +7,7 @@ on:
       - develop
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   build:
@@ -57,19 +57,30 @@ jobs:
         if: steps.check-for-backend.outputs.has-backend == 'true'
         uses: actions/setup-go@v2
         with:
-          go-version: '1.17'
+          go-version: '1.19'
 
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
-          version: latest
+          version: v1.14.0
           args: coverage
 
       - name: Build backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
-          version: v1.12.1
+          version: v1.14.0
           args: buildAll
-          
+
+      - name: Sign plugin
+        run: yarn sign
+        env:
+          GRAFANA_API_KEY: ${{ secrets.GRAFANA_API_KEY }} # Requires a Grafana API key from Grafana.com.
+
+      - name: Upload plugin artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: golioth-websocket-datasource
+          path: ./dist
+          retention-days: 1

CONTRIBUTING.md

@@ -1,4 +1,20 @@
-# <a name="commit"></a> Commit Message Format
+# What is Grafana Data Source Backend Plugin?
+
+Grafana supports a wide range of data sources, including Prometheus, MySQL, and even Datadog. There’s a good chance you can already visualize metrics from the systems you have set up. In some cases, though, you already have an in-house metrics solution that you’d like to add to your Grafana dashboards. Grafana Data Source Plugins enables integrating such solutions with Grafana.
+
+For more information about backend plugins, refer to the documentation on [Backend plugins](https://grafana.com/docs/grafana/latest/developers/plugins/backend/).
+
+A backend data source plugin consists of both frontend and backend components.
+
+In this case, the frontend is written in javascript and the backend is written in golang.
+
+# Summary
+
+- [Commits format](#commit)
+- [Building and running locally](#run-locally)
+- [Learn More related contents](#learn-more)
+
+# <a name="commit" id="commit"></a> Commit Message Format
 
 We have very precise rules over how our Git commit messages must be formatted.
 This format leads to **easier to read commit history**.
@@ -89,7 +105,7 @@ Breaking Change section should start with the phrase "BREAKING CHANGE: " followe
 
 Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
 
-### Revert commits
+### <a name="revert-commit"></a>Revert commits
 
 If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
 
@@ -98,19 +114,11 @@ The content of the commit message body should contain:
 - information about the SHA of the commit being reverted in the following format: `This reverts commit <SHA>`,
 - a clear description of the reason for reverting the commit message.
 
-# Instructions for Building and Running Locally
-
-This is a starting point for building Grafana Data Source Backend Plugins
-
-## What is Grafana Data Source Backend Plugin?
-
-Grafana supports a wide range of data sources, including Prometheus, MySQL, and even Datadog. There’s a good chance you can already visualize metrics from the systems you have set up. In some cases, though, you already have an in-house metrics solution that you’d like to add to your Grafana dashboards. Grafana Data Source Plugins enables integrating such solutions with Grafana.
-
-For more information about backend plugins, refer to the documentation on [Backend plugins](https://grafana.com/docs/grafana/latest/developers/plugins/backend/).
+---
 
-## Getting started
+# Instructions for Building and Running it Locally <a name="run-locally" id="run-locally"></a>
 
-A data source backend plugin consists of both frontend and backend components.
+This is a starting point for building Grafana Data Source Backend Plugins
 
 ### Install Toolchain
 
@@ -241,19 +249,43 @@ A data source backend plugin consists of both frontend and backend components.
    mage -l
    ```
 
-### Run the Grafana
+### Sign the Grafana plugin (Golioth Maintainers)
+
+In case you have a Grafana API KEY, you can sign the plugin locally.
 
-1. Start the docker container
+Set the GRAFANA_API_KEY:
+```
+$ export GRAFANA_API_KEY=<api-key-here>
+```
 
+Sign the plugin:
+```
+$ npm run sign
+```
+
+### Run the Grafana with Docker
+
+1. Start the docker container:
+
+- Run Grafana able to execute **unsigned** plugins
    ```bash
-    docker run \
+   $ docker run \
       --network="host" -e "GF_LOG_MODE=console file" \
       -e "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=golioth-websocket-datasource" \
       -p 3000:3000 \
       -v path/to/your/clone:/var/lib/grafana/plugins \
       --name=grafana grafana/grafana
    ```
 
+- Run Grafana only **for signed** plugins
+   ```bash
+   $ docker run \
+      --network="host" -e "GF_LOG_MODE=console file" \
+      -p 3000:3000 \
+      -v path/to/your/clone:/var/lib/grafana/plugins \
+      --name=grafana grafana/grafana
+   ```
+
    - Notes regarding Docker:
      - Restart container after first run: `docker start grafana`
      - Restart container after first run as daemon: `docker start grafana`
@@ -309,44 +341,36 @@ Every time you modify locally the plugin and desire send this change to be publi
 
 For example, if you put some relative link in the README or some broken link, the validation will claim to you about them. And you'll need fix all of the claims before the submission.
 
-To perform the local validation you must have the `Make` tool installed so that you can run the Makefile's commands and the Grafana's plugin validator `plugincheck` in order to your validate it.
-
-In the root directory you can find a `Makefile` and it contains two commands:
+To perform the local validation you must have the `Make` tool installed so that you can run the Makefile's commands and the Grafana's [plugin validator](https://github.com/grafana/plugin-validator) `plugincheck` in order to your validate it.
 
-- **setup**
+Or, you can skip installing the `plugincheck` locally and just run it through its binary using the `Node Package eXecute - npx command`. This tutorial will run the plugin validation using the `npx` command.
 
-  Run this command if you don't have installed yet the `plugincheck` tool in order to install it.
+In the root directory you can find a `Makefile` with the following commands:
 
 - **validate-plugin**
 
-  Run this command after have installed the plugincheck. It will prepare and perform the plugin validation.
+  Run this command in order to validate the plugin.
 
-To run the commands go to the terminal and goes to the plugin's root directory:
+To run the command open the terminal and goes to the plugin's root directory:
 
 ```
-cd path/to/your/clone/grafana-websocket-plugin
+$ cd path/to/your/clone/grafana-websocket-plugin
 ```
 
-Next, install the plugin validator
+Run the validator:
 
 ```
-make setup
+$ make validate-plugin
 ```
 
-Finally, run the validator:
-
-```
-make validate-plugin
-```
-
-Case the validator realizes some error or warning in your plugin, it will generate in your terminal some kind of output like the following:
+Case the validator realizes any error or warning in your plugin, it will generate in your terminal some kind of output like the following:
 
 ```
 .
 .
 .
 
-plugincheck ./golioth-websocket-datasource.zip || true
+$ plugincheck ./golioth-websocket-datasource.zip || true
 {
   "level": "error",
   "message": "Unsigned plugin",
@@ -359,10 +383,14 @@ plugincheck ./golioth-websocket-datasource.zip || true
 
 You'll need verify each error or warning and solve them before pushing the plugin.
 
-## Learn more
+
+
+# Learn more <a name="learn-more" id="learn-more"></a>
 
 - [Build a data source backend plugin tutorial](https://grafana.com/tutorials/build-a-data-source-backend-plugin)
 - [Grafana documentation](https://grafana.com/docs/)
 - [Grafana Tutorials](https://grafana.com/tutorials/) - Grafana Tutorials are step-by-step guides that help you make the most of Grafana
 - [Grafana UI Library](https://developers.grafana.com/ui) - UI components to help you build interfaces using Grafana Design System
 - [Grafana plugin SDK for Go](https://grafana.com/docs/grafana/latest/developers/plugins/backend/grafana-plugin-sdk-for-go/)
+- [Grafana plugin-validator tool](https://github.com/grafana/plugin-validator)
+- [Grafana Publish Plugin](https://grafana.com/docs/grafana/latest/developers/plugins/publish-a-plugin/#submit-a-plugin-update)

Makefile

@@ -1,9 +1,34 @@
-setup:
-	go get -u github.com/grafana/plugin-validator/cmd/plugincheck
+make clean-build:
+	rm dist
+	rm coverage
+	rm node_modules
+
+setup-frontend:
+	yarn install
+
+build-frontend:
+	yarn build
+
+install-mage:
+	go install github.com/magefile/mage
+
+setup-backend:
+	go get -u github.com/grafana/grafana-plugin-sdk-go
+	go mod tidy
+
+build-backend:
+	# build plugin's backend
+	mage -v
+	
+	# required by plugincheck
+	chmod 0775 dist/gpx_websocket_* 
+
+sign-plugin:
+	npm run sign
 
 validate-plugin:
 	cp -r dist golioth-websocket-datasource
 	zip golioth-websocket-datasource golioth-websocket-datasource -r
-	plugincheck ./golioth-websocket-datasource.zip || true
+	npx -y @grafana/plugin-validator@latest ./golioth-websocket-datasource.zip || true
 	rm -r golioth-websocket-datasource
-	rm golioth-websocket-datasource.zip
+	rm golioth-websocket-datasource.zip

go.mod

@@ -3,7 +3,14 @@ module github.com/grafana/grafana-starter-datasource-backend
 go 1.16
 
 require (
+	github.com/fatih/color v1.15.0 // indirect
+	github.com/gopherjs/gopherjs v1.17.2 // indirect
 	github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c
-	github.com/grafana/grafana-plugin-sdk-go v0.142.0
-	github.com/magefile/mage v1.14.0 // indirect
+	github.com/grafana/grafana-plugin-sdk-go v0.159.0
+	github.com/mattn/go-runewidth v0.0.14 // indirect
+	github.com/rivo/uniseg v0.4.4 // indirect
+	github.com/smartystreets/assertions v1.13.0 // indirect
+	github.com/smartystreets/goconvey v1.7.2 // indirect
+	golang.org/x/exp v0.0.0-20230310171629-522b1b587ee0 // indirect
+	gonum.org/v1/gonum v0.12.0 // indirect
 )