Skip to content

Commit f37adf5

Browse files
committed
Update release process to include updating dependencies
1 parent 6a7f098 commit f37adf5

1 file changed

Lines changed: 24 additions & 8 deletions

File tree

MAINTENANCE.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,35 @@ launched through CCM. Split between regular and extended CI is not yet decided.
8686

8787
## Releasing process
8888

89-
1. Bump the package version. Remember to update the version in `package-lock.json` in
90-
main directory, examples and benchmarks
89+
1. Update the driver dependencies. When updating / upgrading node dependencies,
90+
you can either run `npm update` in the main directory, or manually update `package.json` or `package-lock.json` and run `npm i`.
91+
Remember to run `npm i` in the `examples/` and `benchmark/` directories once you update the packages. See [Updating packages](#updating-packages) for more details.
92+
2. Bump the package version. Remember to update the version in `package-lock.json` in
93+
the main directory, `examples/`, and `benchmark/`. You can do this by running `npm i` in all 3 directories
9194
(see [example commit](https://github.com/scylladb/nodejs-rs-driver/pull/363/changes/41250609737052975129c7514439869324478008) on how to do that).
92-
2. Create a new tag
93-
3. Ensure the extended CI passes.
94-
4. Create release notes on GitHub. The version tag must match version from `package.json` with `v` prefix (for example: `v0.2.0`).
95+
3. Create a new tag.
96+
4. Ensure the extended CI passes.
97+
5. Create release notes on GitHub. The version tag must match version from `package.json` with `v` prefix (for example: `v0.2.0`).
9598
Once you publish release notes, CI action will trigger automatically. This action will build and publish the npm package.
96-
5. Once the CI action finishes, check if it succeeded. If it failed, you will have to fix the underlying issue, and re-run the CI action.
97-
6. Verify that the new release is visible at [npmjs site](https://www.npmjs.com/package/scylladb-driver-alpha).
98-
7. Test the package, by installing it directly from npm. Go to `examples` directory, in `package.json` update the line:
99+
6. Once the CI action finishes, check if it succeeded. If it failed, you will have to fix the underlying issue, and re-run the CI action.
100+
7. Verify that the new release is visible at [npmjs site](https://www.npmjs.com/package/scylladb-driver-alpha).
101+
8. Test the package, by installing it directly from npm. Go to `examples` directory, in `package.json` update the line:
99102
`"scylladb-driver-alpha": "file:./../"`
100103
to:
101104
`"scylladb-driver-alpha": "<just-released-version>"`,
102105
then run the following command:
103106
`npm i && node ./runner.js`
104107
<!-- The last step can potentially be set up as a CI action step. -->
108+
109+
### Updating packages
110+
111+
As we only have a single dependency used for released version of the package, the main goal of this is to update dev dependencies.
112+
This is done to:
113+
114+
1. Resolve dependabot alerts. Doing it for every alert individually would be too tiresome,
115+
but we still want to resolve those alerts.
116+
2. Access to new features. (But the point 1. is way more important).
117+
118+
When bumping version with `npm update` packages will be updated according to `package.json` semantics.
119+
Updating this way, will only update the lock file.
120+
If this is not enough, you can manually update `package.json` or `package-lock.json`.

0 commit comments

Comments
 (0)