Treemap for Grafana

More details about this plugin are available in the README.md file, that gets published here.

Development

Frontend

Important

Prerequisites

• Yarn
• Docker

1. Install dependencies

   yarn install

2. Build plugin in development mode and run in watch mode

   yarn dev

3. Build plugin in production mode

   yarn build

4. Run the tests (using Jest)

   # Runs the tests and watches for changes, requires git init first
   yarn test
   
   # Exits after running all the tests, generates a coverage report
   yarn test:ci

5. Spin up a Grafana instance and run the plugin inside it (using Docker)

   yarn server

6. Run the E2E tests (using Playwright)

   # Runs in a Docker container for consistency, generates a coverage report
   yarn e2e

   SEE: ./e2e/README.md

7. Update the E2E screenshots (using Playwright)

   yarn e2e:update-screenshots

   SEE: ./e2e/README.md

8. Run the linter

   yarn lint
   
   # or
   
   yarn lint:fix

Using Github actions "publish" workflow

Publish (Plugins - CD)

1. Update the version
   • e.g, run yarn version <major|minor|patch>
2. Update the CHANGELOG
3. Commit and push changes, merge to main
4. Release and test plugin for dev environments:
   • Go to Plugins - CD and "Run workflow"
     • Leave "use workflow from" as main
     • Choose dev as the environment to publish to
     • Choose main as the branch to publish from
     • It is possible to choose a PR for an earlier test on dev
   • Manually test Evaluate the plugin from a dev environment
5. Release and plugin for prod environments:
   • Go to Plugins - CD and "Run workflow"
     • Leave "use workflow from" as main
     • Choose prod as the environment to publish to
     • Choose main as the branch to publish from