Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,3 @@ mage_output_file.go

# provisioning
/provisioning/

.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/sdks
!.yarn/versions
6 changes: 6 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ignore-scripts=true
# TODO: implement allow-git workaround for @grafana/ui packages
#allow-git=none
min-release-age=3
registry=https://registry.npmjs.org/
save-exact=true
944 changes: 0 additions & 944 deletions .yarn/releases/yarn-4.17.1.cjs

This file was deleted.

5 changes: 0 additions & 5 deletions .yarnrc.yml

This file was deleted.

2 changes: 1 addition & 1 deletion cspell.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"query.panel.schema.json",
"query.request.schema.json",
"query.types.json",
"yarn.lock"
"package-lock.json"
],
"ignoreRegExpList": ["import\\s*\\((.|[\r\n])*?\\)", "import\\s*.*\".*?\""],
"words": [
Expand Down
16 changes: 8 additions & 8 deletions docs/developer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For this standard execution, you will need the following tools:

- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
- [Yarn](https://classic.yarnpkg.com/en/docs/install)
- [npm](https://www.npmjs.com)
- [Grafana Toolkit](https://www.npmjs.com/package/@grafana/toolkit)

## Running the development version
Expand All @@ -29,17 +29,17 @@ mage build:linux && mage reloadPlugin

### Compiling the Frontend

After you made the desired changes, you can build and test the new version of the plugin using `yarn`:
After you made the desired changes, you can build and test the new version of the plugin using `npm`:

```sh
yarn test # run all test cases
yarn dev # builds and puts the output at ./dist
npm test # run all test cases
npm run dev # builds and puts the output at ./dist
```

Alternatively, you can have yarn watch for changes and automatically recompile them.
Alternatively, you can have npm watch for changes and automatically recompile them.

```sh
yarn watch
npm run watch
```

Now that you have a `./dist` folder, you are ready to run a fresh Grafana instance and put the new version of the datasource into [Grafana plugin folder](https://grafana.com/docs/grafana/latest/plugins/installation/).
Expand Down Expand Up @@ -68,10 +68,10 @@ You can find example dashboard that uses GitHub data source in [dashboards folde

## Submitting PR

If you are creating a PR, ensure to run `yarn changeset` from your branch. Provide the details accordingly. It will create `*.md` file inside `./.changeset` folder. Later during the release, based on these changesets, package version will be bumped and changelog will be generated.
If you are creating a PR, ensure to run `npx changeset` from your branch. Provide the details accordingly. It will create `*.md` file inside `./.changeset` folder. Later during the release, based on these changesets, package version will be bumped and changelog will be generated.

## Releasing & Bumping version

To create a new release, execute `yarn changeset version`. This will update the Changelog and bump the version in `package.json` file. Commit those changes. Run the `Plugins - CD` GitHub Action to publish the new release.
To create a new release, execute `npx changeset version`. This will update the Changelog and bump the version in `package.json` file. Commit those changes. Run the `Plugins - CD` GitHub Action to publish the new release.

## Development resources
7 changes: 0 additions & 7 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,6 @@ export default defineConfig([
'**/__debug_bin',
'**/mage_output_file.go',
'provisioning/',
'**/.pnp.*',
'.yarn/*',
'!.yarn/patches',
'!.yarn/plugins',
'!.yarn/releases',
'!.yarn/sdks',
'!.yarn/versions',
],
},
...baseConfig,
Expand Down
Loading
Loading