Migrate from grafana-toolkit to grafana plugin tools #3837
Conversation
maskin25
added
the
pr:no public docs
grafana-plugin/.config/.cprc.json
Outdated
| @@ -0,0 +1,3 @@ | |||
| { | |||
| "version": "3.3.0" | |||
There was a problem hiding this comment.
is this scaffolded by create-plugin or what's this file for?
grafana-plugin/.nvmrc
Outdated
| @@ -0,0 +1 @@ | |||
| 20 | |||
There was a problem hiding this comment.
- It's pity .nvmrc doesn't support comments but at least maybe we can use "v20" to indicate this s about node version?
- It would be good to restrict this version in
package.jsonusing https://docs.npmjs.com/cli/v10/configuring-npm/package-json#engines ? wdyt? - Also it this case we stick to Node v20 on local but on on Github Actions and Drone it seems we use 18.16.0. I think we should be consistent here and use the same version. If not in this PR, can we create a task and add it to our frontend tech backlog pls?
There was a problem hiding this comment.
+1 for keeping the node versions the same on CI as local. A few spots that would need to be changed (this should be all, but you'll want to double check):
- https://github.com/grafana/oncall/blob/dev/grafana-plugin/Dockerfile.dev#L1
- https://github.com/grafana/oncall-private/blob/dev/.drone.yml
- https://github.com/grafana/oncall/blob/dev/.drone.yml
- https://github.com/grafana/oncall/blob/dev/.github/workflows/linting-and-tests.yml
- https://github.com/grafana/oncall/blob/dev/.github/workflows/e2e-tests.yml
There was a problem hiding this comment.
ok, I'll set 18.16.0 in .nvmrc and in the engines section:
"engines": {
"node": "~18.16.0"
},
grafana-plugin/package.json
Outdated
| "labels:link": "yarn --cwd ../../gops-labels/frontend link && yarn link \"@grafana/labels\" && yarn --cwd ../../gops-labels/frontend watch", | ||
| "labels:unlink": "yarn --cwd ../../gops-labels/frontend unlink", | ||
| "test": "jest --verbose", | ||
| "test:silent": "jest --silent", | ||
| "test:e2e": "yarn playwright test --grep-invert @expensive", | ||
| "test:e2e-expensive": "yarn playwright test --grep @expensive", | ||
| "e2e": "yarn exec cypress install && yarn exec grafana-e2e run", | ||
| "e2e:update": "yarn exec cypress install && yarn exec grafana-e2e run --update-screenshots", |
There was a problem hiding this comment.
those are not needed I guess?
grafana-plugin/package.json
Outdated
| "@grafana/eslint-config": "^5.1.0", | ||
| "@grafana/toolkit": "^9.5.2", | ||
| "@grafana/e2e": "10.0.3", | ||
| "@grafana/e2e-selectors": "10.0.3", |
There was a problem hiding this comment.
I think we don't use those 2. grafana-e2e is a wrapper over Cypress that makes it easier to test Grafana. We use Playwright and there's another fresh project for Playwright that we might switch to in nearest future (https://github.com/grafana/plugin-tools/tree/main/packages/plugin-e2e). But I think everything related to Cypress can be removed from our project
| })(baseConfig, customConfig); | ||
| }; | ||
|
|
||
| export default config; |
grafana-plugin/package.json
Outdated
| "start": "yarn watch", | ||
| "plop": "plop", | ||
| "test:ci": "jest --passWithNoTests --maxWorkers 4", | ||
| "typecheck": "tsc --noEmit", |
There was a problem hiding this comment.
do we need these 2?
test:ci doesn't seem to be used part of CI
typecheck seems more like a job for webpack than for us to run 🤔
There was a problem hiding this comment.
typecheck looks useful for me, let's keep it, and I've removed test:ci
| @@ -1,3 +1,5 @@ | |||
| // @ts-nocheck | |||
There was a problem hiding this comment.
We shouldn't edit this file, it's autogenerated so on the next run your change will be lost. Instead we can edit generate-types script to do the same on every run. I suggest:
# What this PR does Migrate from grafana-toolkit to grafana plugin tools ## Which issue(s) this PR fixes #3651 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required) --------- Co-authored-by: Michael Derynck <[email protected]> Co-authored-by: Dominik <[email protected]>
What this PR does
Migrate from grafana-toolkit to grafana plugin tools
Which issue(s) this PR fixes
#3651
Checklist
pr:no public docsPR label added if not required)CHANGELOG.mdupdated (orpr:no changelogPR label added if not required)