temporalio / temporalio/samples-typescript

[Feature Request] Ensure all samples can be fully built, run and validated in automated way

Open
#259 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
465
Forks
148
Avg merge
1d 10h
Merged PRs (30d)
11

Description

What

Add a script on each sample that perform a completely automated validation of that sample.

Why

High quality samples are essential to allow users to learn and start using Temporal. Unfortunately, from time to time, some sample stops working. Common situations leading to sample failure are dependencies getting updated in incompatible ways, and Temporal SDK itself introducing breaking changes.

At the moment, testing samples is unreasonably time consuming, notably because samples doesn't all follow the same execution semantic (most are using npm run start and npm run workflow, but ~25% require different steps), some require particular environment (eg. Mongo), and because "success" is not always obvious.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no specific files, tests, or entry points. Start by inventorying the samples and their existing build and run commands, including samples that need environments such as Mongo. Done means every sample has a consistent automated build, run, and validation path.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.