Skip to content

Commit cb10295

Browse files
authored
docs: Add --exact and ConnectionOptions.interceptors note (#908)
* docs: Add `--exact` and `ConnectionOptions.interceptors` note * add samples step
1 parent d49c853 commit cb10295

File tree

2 files changed

+27
-14
lines changed

2 files changed

+27
-14
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -192,26 +192,35 @@ for f in ~/Downloads/packages-*.zip; do mkdir "$HOME/Downloads/$(basename -s .zi
192192
# we should now have all 5 build targets
193193
ls packages/core-bridge/releases/
194194

195-
npx lerna version patch --force-publish='*' # or major|minor|etc, or leave out to be prompted. either way, you get a confirmation dialog.
195+
npx lerna version patch --exact --force-publish='*' # or major|minor|etc, or leave out to be prompted. either way, you get a confirmation dialog.
196196
npx lerna publish from-git # add `--dist-tag next` for pre-release versions
197197

198198
npm deprecate temporalio@^1.0.0 "Instead of installing temporalio, we recommend directly installing our packages: npm remove temporalio; npm install @temporalio/client @temporalio/worker @temporalio/workflow @temporalio/activity"
199199
```
200200

201201
- Cleanup after publishing:
202202

203-
```sh
204-
rm $HOME/Downloads/packages-*
205-
rm packages/core-bridge/releases/
206-
```
203+
```sh
204+
rm $HOME/Downloads/packages-*
205+
rm packages/core-bridge/releases/
206+
```
207207

208208
- If any APIs have changed, open a PR to update [`samples-typescript`](https://github.com/temporalio/samples-typescript/). Once merged, update the `next` branch:
209209

210-
```sh
211-
git checkout next
212-
git rebase origin/main
213-
git push
214-
```
210+
```sh
211+
git checkout next
212+
git rebase origin/main
213+
git push
214+
```
215+
216+
- While our tests should capture most things, if you want to verify the release works in the samples, do:
217+
218+
```sh
219+
cd /path/to/samples-typescript
220+
lerna exec -- npm update
221+
npm run build
222+
npm test
223+
```
215224

216225
### Updating published packages
217226

packages/client/src/connection.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,14 @@ export interface ConnectionOptions {
5353
channelArgs?: grpc.ChannelOptions;
5454

5555
/**
56-
* Grpc interceptors which will be applied to every RPC call performed by this connection. By
57-
* default, an interceptor will be included which automatically retries retryable errors. If you
58-
* do not wish to perform automatic retries, set this to an empty list (or a list with your own
59-
* interceptors).
56+
* Grpc interceptors which will be applied to every RPC call performed by this connection. By default, an interceptor
57+
* will be included which automatically retries retryable errors. If you do not wish to perform automatic retries, set
58+
* this to an empty list (or a list with your own interceptors). If you want to add your own interceptors while
59+
* keeping the default retry behavior, add this to your list of interceptors:
60+
* `makeGrpcRetryInterceptor(defaultGrpcRetryOptions())`. See:
61+
*
62+
* - @link makeGrpcRetryInterceptor
63+
* - @link defaultGrpcRetryOptions
6064
*/
6165
interceptors?: grpc.Interceptor[];
6266

0 commit comments

Comments
 (0)