Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add message-passing samples to index, housekeeping #384

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ jobs:
hello-world-js,
hello-world-mtls,
interceptors-opentelemetry,
message-passing/introduction,
message-passing/signals-queries-cancellation,
message-passing/execute-update,
message-passing/safe-message-handlers,
monorepo-folders,
mutex,
nestjs-exchange-rates,
Expand All @@ -79,7 +83,6 @@ jobs:
saga,
schedules,
search-attributes,
signals-queries,
sinks,
snippets,
state,
Expand Down
2 changes: 1 addition & 1 deletion .scripts/copy-shared-files.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const POST_CREATE_EXCLUDE = [
'expense',
'production',
'patching-api',
'signals-queries',
'message-passing/signals-queries-cancellation',
'activities-cancellation-heartbeating',
'nestjs-exchange-rates',
'food-delivery',
Expand Down
3 changes: 1 addition & 2 deletions .scripts/list-of-samples.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
"schedules",
"scratchpad",
"search-attributes",
"signals-queries",
"sinks",
"snippets",
"state",
Expand All @@ -42,4 +41,4 @@
"worker-specific-task-queues",
"worker-versioning"
]
}
}
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,13 @@ and you'll be given the list of sample options.
#### Workflow APIs

- **Timers**:
- The [**progress example**](./timer-progress) demonstrates how to use the `sleep` function from `@temporalio/workflow`.
- [**Timer Examples**](./timer-examples):
- [**Timer**](./timer-examples):
- Send a notification to the customer if their order is taking longer than expected (using a `Promise.race` between the order activity and `sleep`).
- Create an `UpdatableTimer` that can be slept on, and at the same time, have its duration updated via Signals.
- **Signals and Triggers**:
- The [**Signals and Queries example**](https://github.com/temporalio/samples-typescript/tree/main/signals-queries) demonstrates the usage of Signals, Queries, and Workflow Cancellation.
- [**Timer Progress**](./timer-progress): demonstrates how to use the `sleep` function from `@temporalio/workflow`.
- **Message-passing**:
- [**Introduction**](https://github.com/temporalio/samples-typescript/tree/main/message-passing/introduction): an introduction to Query, Signal, and Update.
- [**Cancellation**](https://github.com/temporalio/samples-typescript/tree/main/message-passing/signals-queries-cancellation) demonstrates the usage of Signals, Queries, and Workflow Cancellation.
- [**Mutex**](https://github.com/temporalio/samples-typescript/tree/main/mutex): Workflows send Signals to each other in this example of `lockWorkflow` acting as a mutex.
- [**State**](https://github.com/temporalio/samples-typescript/tree/main/state): The Workflow maintains state in a `Map<string, number>`, and the state can be updated and read via a Signal and a Query.
- **Async activity completion**: Example of an [**Expense reporting**](https://github.com/temporalio/samples-typescript/tree/main/expense) Workflow that communicates with a server API. Shows how to kick off a Workflow and manually complete it at an arbitrarily later date.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading