temporalio / temporalio/samples-typescript

[Bug] The sample index file doesn't know about subdirectories

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

Nobody has claimed this yet.

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

Description

Some of our samples are grouped in subdirectories, e.g. message-passing/execute-update. However, the script that refreshes the list-of-samples.json file doesn't know about that structure, do the index file only contains the parent directory, e.g. message-passing.

Note that there might also be a related issue with the @temporalio/create command in instantiating a local repo from such a sample.

Repro

samples-typescript(pnpm) npx @temporalio/create@latest my-project
[...]
✔ Which sample would you like to use? › message-passing
Could not locate a sample named "message-passing". It could be due to the following:
 1. Your spelling of sample "message-passing" might be incorrect.
 2. You might not be connected to the internet.

Available samples:

[...]
message-passing
[...]

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

Start by tracing the script that generates list-of-samples.json and the @temporalio/create sample-selection path, using the message-passing/execute-update example as the case to follow. Check how nested sample directories are indexed and instantiated. Done means the index exposes the usable nested sample and npx @temporalio/create can select and create a project from it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.