Skip to content

Commit b763b0e

Browse files
authored
docs: Add version 1.1.0 to CHANGELOG (#832)
1 parent 7a142d3 commit b763b0e

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

CHANGELOG.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,67 @@ All notable changes to this project will be documented in this file.
44

55
Breaking changes marked with a :boom:
66

7+
## [1.1.0] - 2022-08-20
8+
9+
### Bug Fixes
10+
11+
- :boom: [`worker`] Remove unnecessary `ReplayWorkerOptions` ([#816](https://github.com/temporalio/sdk-typescript/pull/816))
12+
13+
BREAKING CHANGE: While this is technically breaking (if you pass options that are irrelevant to replay like `maxActivitiesPerSecond`, you'll get a compilation error), we decided it did not warrant a major version bump, as it doesn't affect production code (replay is a testing feature) and is only a type change (is caught at compile type by TS users and doesn't affect JS users).
14+
15+
- Warn instead of throwing when getting `workflowBundle` with `workflowsPath` and `bundlerOptions` ([#833](https://github.com/temporalio/sdk-typescript/pull/833))
16+
17+
⚠️ NOTE: We now prefer taking `workflowBundle` over `workflowsPath` when both are provided, which is the correct behavior and what users should expect.
18+
19+
We also now warn that workflow interceptors are ignored when using `workflowBundle`.
20+
21+
- [`workflow`] Make breakpoints work inside workflow isolate context ([#819](https://github.com/temporalio/sdk-typescript/pull/819))
22+
23+
⚠️ NOTE: Bundles created with `bundleWorkflowCode` should only be used for calling `Worker.create` when the exact same version of `@temporalio/worker` is used. (If you don't pin to exact versions in your `package.json`, then you should use a lockfile, and both the machine that runs `bundleWorkflowCode` and `Worker.create` should run `npm ci`, not `npm install`.)
24+
25+
⚠️ DEPRECATION: `sourceMap` and `sourceMapPath` are now deprecated. We've inlined source maps, so now this works:
26+
27+
```ts
28+
const { code } = await bundleWorkflowCode({ workflowsPath });
29+
const worker = await Worker.create({ workflowBundle: { code }, ...otherOptions });
30+
```
31+
32+
- Avoid using dynamic import in `@temporalio/testing` ([#805](https://github.com/temporalio/sdk-typescript/pull/805))
33+
- [`worker`] Don't start activity poller if no activities registered ([#808](https://github.com/temporalio/sdk-typescript/pull/808))
34+
- Update `proto3-json-serializer` to `^1.0.3` ([#809](https://github.com/temporalio/sdk-typescript/pull/809))
35+
- Help protobufjs find `long` in Yarn3 ([#810](https://github.com/temporalio/sdk-typescript/issues/810)) ([#814](https://github.com/temporalio/sdk-typescript/pull/814))
36+
- Add `@types/long` to client ([#735](https://github.com/temporalio/sdk-typescript/pull/735))
37+
- [`worker`] Improve worker default options heuristics ([#802](https://github.com/temporalio/sdk-typescript/pull/802))
38+
- Use `GITHUB_TOKEN` in `create-project` for CI ([#721](https://github.com/temporalio/sdk-typescript/pull/721))
39+
40+
### Features
41+
42+
- :boom: [`worker`] Add webpack configuration, closes [#537](https://github.com/temporalio/sdk-typescript/issues/537) ([#815](https://github.com/temporalio/sdk-typescript/pull/815))
43+
44+
This was our most-upvoted feature request! ([9 👍's](https://github.com/temporalio/sdk-typescript/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc).) See [`WorkerOptions.bundlerOptions.webpackConfigHook`](https://typescript.temporal.io/api/interfaces/worker.workeroptions/#bundleroptions) for usage.
45+
46+
BREAKING CHANGE: If you provide both `workflowBundle` & `workflowsPath` or both `workflowBundle` & `bundlerOptions` to `Worker.create`, a `ValueError` will now be thrown. While this is technically breaking, TODO
47+
48+
- Add `@temporalio/nyc-test-coverage` package ([#798](https://github.com/temporalio/sdk-typescript/pull/798), thanks to [`@vkarpov15`](https://github.com/vkarpov15) 🙏)
49+
50+
This package adds code coverage for Istanbul. It's currently in beta: the API may be unstable as we gather feedback on it from users. To try it out, see [this code snippet](https://github.com/temporalio/sdk-typescript/pull/798#issue-1323652976) for current usage.
51+
52+
- [`common`] Improve `ApplicationFailure` arguments; add `.create` and `.fromError` ([#767](https://github.com/temporalio/sdk-typescript/pull/767))
53+
54+
See [`ApplicationFailure.create`](https://typescript.temporal.io/api/classes/common.applicationfailure/#create) and [`ApplicationFailure.fromError`](https://typescript.temporal.io/api/classes/common.applicationfailure/#fromerror)
55+
56+
- Expose additional console methods to workflow context ([#831](https://github.com/temporalio/sdk-typescript/pull/831))
57+
58+
`console.[error|warn|info|debug]` can now be called from Workflow code, in addition to `console.log`
59+
60+
### Documentation
61+
62+
- Add package list to README ([#803](https://github.com/temporalio/sdk-typescript/pull/803))
63+
- Add API doc for `bundleWorkflowCode`, fixes [#792](https://github.com/temporalio/sdk-typescript/issues/792) ([#793](https://github.com/temporalio/sdk-typescript/pull/793))
64+
- Surface missing core-bridge exports ([#812](https://github.com/temporalio/sdk-typescript/pull/812))
65+
- Export missing `ApplicationFailureOptions` ([#823](https://github.com/temporalio/sdk-typescript/pull/823))
66+
- Improve API reference ([#826](https://github.com/temporalio/sdk-typescript/pull/826))
67+
768
## [1.0.1] - 2022-07-29
869

970
### Bug Fixes

0 commit comments

Comments
 (0)