Skip to content

Commit 18162df

Browse files
authored
Updating developer docs with npmjs publishing steps (#622)
Signed-off-by: Paul Yuknewicz <[email protected]>
1 parent d7547ce commit 18162df

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

documentation/development.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,27 @@ npm run start:dev
2222

2323
## Publishing Package Package Maintenance
2424

25-
For publishing a new version, we update the version in `package.json` and we run `./publish.sh`
25+
To publish a new package to [https://www.npmjs.com/package/@dapr/dapr](https://www.npmjs.com/package/@dapr/dapr) we need to do the following building and publishing steps.
26+
27+
For **building** a new version, we:
28+
- update the version in `package.json` in the repo root, e.g. `3.4.0` for a final releaes or `3.4.0-rc.1` for a pre-release
29+
- run `npm install` again to refresh lock file (it should now be dirty and part of the change list)
30+
- verify the dapr runtime and versions in [./scripts/fetch-proto.sh](./scripts/fetch-proto.sh) and update if necessary
31+
- run `./scripts/fetch-proto.sh` from the repo root to regenerate protos to match runtime
32+
- verify [.github/workflows/test-e2e.yml](.github/workflows/test-e2e.yml) env variables, especially the Dapr and Node versions to test against
33+
34+
PR this change into the right release branch, e.g. `release-3.4.0`. Merging to `master` branch should happen last.
2635

2736
A custom script is utilized here since we have 2 libraries in one for HTTP and gRPC
2837

38+
For **publishing** the package, we simply cut a new release by:
39+
- create a new release/tag in the dapr/js-sdk repo
40+
- for a final release the tag should look like `v3.4.0` and mark it as final official release. Generate release notes using the N-1 released version, e.g. using 3.3.1.
41+
- for a pre-release it should look like `v3.4.0-rc.1` and mark it as a pre-release
42+
- verify the package is now uploaded to [https://www.npmjs.com/package/@dapr/dapr](https://www.npmjs.com/package/@dapr/dapr) and shows the new version
43+
44+
Publishing is automated in the CI/CD pipeline. Each time a version is release (GitHub ref starting with `refs/tags/v`) then the pipeline will deploy the package as described in [build.yml](./.github/workflows/build.yml).
45+
2946
## Running Tests
3047

3148
Tests are written per protocol layer: http or grpc. This is done because Dapr requires endpoints to be registered for for pubsub and bindings, making us having to start up the test, initialize those endpoints and then run. Since Dapr is a sidecar architecture, we thus have to start 2 test suites seperately. It requires the following containers:
@@ -50,10 +67,6 @@ npm run test:e2e:grpc
5067
npm run test:e2e:http
5168
```
5269

53-
## Publishing
54-
55-
Publishing is automated in the CI/CD pipeline. Each time a version is release (GitHub ref starting with `refs/tags/v`) then the pipeline will deploy the package as described in [build.yml](./.github/workflows/build.yml).
56-
5770
## Setup GitHub actions
5871

5972
1. Fork the [js-sdk](https://github.com/dapr/js-sdk) repo to your GitHub account.

0 commit comments

Comments
 (0)