Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.13 KB

Contributing

Build

First, install dependencies. Node 12.x is required

yarn install

To work with this plugin run:

yarn watch

This will run linting tools and apply prettier fix.

Use an actual Docker container in parallel to test:

$ docker run --rm -p 3000:3000 -v "$(pwd)"/dist:/var/lib/grafana/plugins/cloudspout-button-panel --name=grafana grafana/grafana:7.3.3

To build the plugin run:

npm run dist

Publish

  1. Update README.md for the correct, upcomming version.

  2. GRAFANA_API_KEY=... npx @grafana/toolkit plugin:sign
GITHUB_TOKEN=... GRAFANA_API_KEY=... npm run release

    or GitHub action

Distribute

  1. Check new release asset with the validator: https://grafana-plugins-web-vgmmyppaka-lz.a.run.app/
  2. Update Grafana's repo.json entry

Resources