Skip to content

Commit

Permalink
Passes prettier build step now. development.md Formatted with pr… (
Browse files Browse the repository at this point in the history
…#624)

Passes `prettier` build step now.  `development.md` Formatted with prettier.

Signed-off-by: Paul Yuknewicz <[email protected]>
  • Loading branch information
paulyuk authored Aug 18, 2024
1 parent eb4988f commit 5cefcf1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions documentation/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 5cefcf1

Please sign in to comment.