Update plugin README (#48)

* Update README and screenshot, remove plop for build info since version is now displayed prominently

* Sign build

Co-authored-by: Michael Derynck <michael.derynck@grafana.com>

.drone.yml

@@ -12,7 +12,6 @@ steps:
       - cd grafana-plugin/
       - if [ -z "$DRONE_TAG" ]; then echo "No tag, not modifying version"; else jq '.version="${DRONE_TAG}"' package.json > package.new && mv package.new package.json && jq '.version' package.json; fi
       - yarn --network-timeout 500000
-      - yarn plop "Append build info" "${DRONE_TAG}" "${DRONE_BRANCH}" "${DRONE_COMMIT}"
       - yarn build
       - ls ./
 
@@ -236,6 +235,6 @@ kind: secret
 name: drone_token
 ---
 kind: signature
-hmac: 5cdafa5ca416acb1763d1d9ac93bbd932982c874718f40af533914a6711c1a1f
+hmac: b42fdbbe647ee80391e473b5a18ab0469609c70d1b919a31fe0fdab8c208515e
 
 ...

CHANGELOG.md

@@ -1,3 +1,5 @@
 # Change Log
 
-## 1.0.0 (2022-02-02)
+## 0.0.71 (2022-06-06)
+
+- Initial Release

grafana-plugin/plopfile.js

@@ -1,11 +1,9 @@
 const createComponentFiles = require('./tools/plop/generators/createComponentFiles');
 const createContainerFiles = require('./tools/plop/generators/createContainerFiles');
 const createModelFiles = require('./tools/plop/generators/createModelFiles');
-const appendReadmeFile = require('./tools/plop/generators/appendReadmeFile');
 const componentPrompts = require('./tools/plop/prompts/componentPrompts');
 const containerPrompts = require('./tools/plop/prompts/containerPrompts');
 const modelPrompts = require('./tools/plop/prompts/modelPrompts');
-const readmePrompts = require('./tools/plop/prompts/readmePrompts');
 
 // const configNeededHelper = require('./tools/plop/helpers/configNeeded');
 
@@ -32,9 +30,4 @@ module.exports = function plopGenerator(plop) {
     actions: (answers) => createContainerFiles(answers),
   });
 
-  plop.setGenerator('Append build info', {
-    description: 'Add build info to plugin readme',
-    prompts: readmePrompts,
-    actions: (answers) => appendReadmeFile(answers),
-  });
 };

grafana-plugin/src/README.md

@@ -12,12 +12,3 @@ with Brilliant Slack Integration
 ## Documentation
 - [On Github](http://github.com/grafana/oncall)
 - [Grafana OnCall](https://grafana.com/docs/grafana-cloud/oncall/)
-- [Connect to Grafana OnCall](https://grafana.com/docs/grafana-cloud/oncall/oncall-integrations/)
-	- [Alertmanager](https://grafana.com/docs/grafana-cloud/oncall/oncall-integrations/alertmanager/)
-	- [Grafana Cloud Alerting](https://grafana.com/docs/grafana-cloud/oncall/oncall-integrations/grafana/)
-	- [Zabbix](https://grafana.com/docs/grafana-cloud/oncall/oncall-integrations/zabbix/)
-	- [Custom Integrations](https://grafana.com/docs/grafana-cloud/oncall/oncall-integrations/custom/)
-- [HTTP API Reference](https://grafana.com/docs/grafana-cloud/oncall/oncall-api-reference/)
-
-\
-/* BUILD INFO */

grafana-plugin/tools/plop/generators/appendReadmeFile.js

@@ -1,16 +0,0 @@
-module.exports = function createReadmeFiles(answers) {
-  const actions = [];
-
-  const pathToApp = 'src';
-
-  const pathToReadmeTemplate = 'tools/plop/templates';
-
-  actions.push({
-    type: 'modify',
-    path: `${pathToApp}/README.md`,
-    pattern: '/* BUILD INFO */',
-    templateFile: `${pathToReadmeTemplate}/BuildInfo.md.hbs`,
-  });
-
-  return actions;
-};

grafana-plugin/tools/plop/prompts/readmePrompts.js

@@ -1,17 +0,0 @@
-module.exports = [
-  {
-    type: 'input',
-    name: 'gitTag',
-    message: 'Git Tag',
-  },
-  {
-    type: 'input',
-    name: 'gitBranch',
-    message: 'Git Branch',
-  },
-  {
-    type: 'input',
-    name: 'gitCommit',
-    message: 'Git Commit',
-  },
-];

grafana-plugin/tools/plop/templates/BuildInfo.md.hbs

@@ -1 +0,0 @@
-<sub>Build Info - Tag: {{gitTag}} - Branch: {{gitBranch}} - Commit: {{gitCommit}}</sub>