Skip to content

Commit f915256

Browse files
authored
Add release instructions (#2)
* add release instructions * remove drone info from readme
1 parent 02317e5 commit f915256

File tree

2 files changed

+4
-14
lines changed

2 files changed

+4
-14
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ Want to install this repo locally?
1111
- run those instructions in the external consumer (athena)
1212
- if you get a yarn version >2:
1313
- in consumer package (ex grafana) `yarn link path-to-sdk` it should add a portal resolution to your package.json
14+
15+
## Creating a Release
16+
17+
Creating a new release requires running the [NPM bump version action](https://github.com/grafana/grafana-async-query-data-js/actions/workflows/npm-bump-version.yml). Click `Run workflow` and specify the type of release (patch, minor, or major). The workflow will update package.json, commit and push which will trigger the [Create Release action](https://github.com/grafana/grafana-async-query-data-js/actions/workflows/create-release.yml) which publishes to npm and creates a github release with release notes.

README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
11
# Async Query
22

33
This library provides frontend support for handling queries in an asynchronous manner. It requires a backend that can handle asynchronous queries.
4-
5-
## Frontend configuration
6-
7-
see the ./src folder
8-
9-
## Drone configuration
10-
11-
Drone signs the Drone configuration file. This needs to be run everytime the drone.yml file is modified. See https://github.com/grafana/deployment_tools/blob/master/docs/infrastructure/drone/signing.md for more info.
12-
13-
To update the drone file run (note that you need to export your `DRONE_TOKEN` before):
14-
15-
```
16-
drone --server https://drone.grafana.net sign --save grafana/grafana-async-query-data-js
17-
```

0 commit comments

Comments
 (0)