Skip to content

Commit cda094c

Browse files
authored
docs: Update release instructions (#835)
1 parent 50b3a2f commit cda094c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ git-cliff --tag 1.0.1 v1.0.0..HEAD | pbcopy
173173
We're [working on automating](https://github.com/temporalio/sdk-typescript/pull/395) the rest of the process:
174174

175175
- Log in to npm as `temporal-sdk-team` (`npm whoami` and `npm login`)
176-
- Download the artifacts from [GitHub Actions](https://github.com/temporalio/sdk-typescript/actions)
176+
- Download the 5 `packages-*` artifacts from the PR's [GitHub Action](https://github.com/temporalio/sdk-typescript/actions)
177177
- Publish:
178178

179179
```sh
@@ -194,6 +194,8 @@ ls packages/core-bridge/releases/
194194

195195
npx lerna version patch # 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
197+
198+
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"
197199
```
198200

199201
- Cleanup after publishing:
@@ -203,6 +205,14 @@ rm $HOME/Downloads/packages-*
203205
rm packages/core-bridge/releases/
204206
```
205207

208+
- If any APIs have changed, open a PR to update [`samples-typescript`](https://github.com/temporalio/samples-typescript/). Once merged, update the `next` branch:
209+
210+
```sh
211+
git checkout next
212+
git rebase origin/main
213+
git push
214+
```
215+
206216
### Updating published packages
207217

208218
`npm` commands we may need to use:
@@ -227,7 +237,7 @@ npm dist-tag rm temporalio next
227237
When we want to deprecate a package:
228238

229239
```
230-
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"
240+
npm deprecate temporalio@^1.0.0 "deprecation message that will be logged on install"
231241
```
232242

233243
## Updating the Java test server proto files

0 commit comments

Comments
 (0)