From 5cefcf1d803670ac11f64be267f6daabc6632de7 Mon Sep 17 00:00:00 2001 From: Paul Yuknewicz Date: Sat, 17 Aug 2024 22:07:54 -0700 Subject: [PATCH] =?UTF-8?q?Passes=20`prettier`=20build=20step=20now.=20=20?= =?UTF-8?q?`development.md`=20Formatted=20with=20pr=E2=80=A6=20(#624)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Passes `prettier` build step now. `development.md` Formatted with prettier. Signed-off-by: Paul Yuknewicz --- documentation/development.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/documentation/development.md b/documentation/development.md index 91cf54e7..432df1df 100644 --- a/documentation/development.md +++ b/documentation/development.md @@ -25,21 +25,23 @@ npm run start:dev 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. +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 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 +- 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).