diff --git a/documentation/development.md b/documentation/development.md index dec7f6d4..91cf54e7 100644 --- a/documentation/development.md +++ b/documentation/development.md @@ -22,10 +22,27 @@ npm run start:dev ## Publishing Package Package Maintenance -For publishing a new version, we update the version in `package.json` and we run `./publish.sh` +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. + +For **building** a new version, we: +- 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 +- run `npm install` again to refresh lock file (it should now be dirty and part of the change list) +- verify the dapr runtime and versions in [./scripts/fetch-proto.sh](./scripts/fetch-proto.sh) and update if necessary +- run `./scripts/fetch-proto.sh` from the repo root to regenerate protos to match runtime +- verify [.github/workflows/test-e2e.yml](.github/workflows/test-e2e.yml) env variables, especially the Dapr and Node versions to test against + +PR this change into the right release branch, e.g. `release-3.4.0`. Merging to `master` branch should happen last. A custom script is utilized here since we have 2 libraries in one for HTTP and gRPC +For **publishing** the package, we simply cut a new release by: +- create a new release/tag in the dapr/js-sdk repo + - 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. + - for a pre-release it should look like `v3.4.0-rc.1` and mark it as a pre-release +- 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 + +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). + ## Running Tests 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 npm run test:e2e:http ``` -## Publishing - -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). - ## Setup GitHub actions 1. Fork the [js-sdk](https://github.com/dapr/js-sdk) repo to your GitHub account.