You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: documentation/development.md
+18-5
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,27 @@ npm run start:dev
22
22
23
23
## Publishing Package Package Maintenance
24
24
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.
26
35
27
36
A custom script is utilized here since we have 2 libraries in one for HTTP and gRPC
28
37
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
+
29
46
## Running Tests
30
47
31
48
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
50
67
npm run test:e2e:http
51
68
```
52
69
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
-
57
70
## Setup GitHub actions
58
71
59
72
1. Fork the [js-sdk](https://github.com/dapr/js-sdk) repo to your GitHub account.
0 commit comments