Skip to content

docs(task-graph): fix TaskOutputTabularRepository README examples for new constructor signature#551

Merged
sroussey merged 1 commit into
mainfrom
claude/beautiful-mayer-Mqpl3
Jun 10, 2026
Merged

docs(task-graph): fix TaskOutputTabularRepository README examples for new constructor signature#551
sroussey merged 1 commit into
mainfrom
claude/beautiful-mayer-Mqpl3

Conversation

@sroussey

@sroussey sroussey commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Commit c011234 removed the LegacyTaskOutputRepositoryOptions shim, so TaskOutputTabularRepository's constructor now only accepts { storage: ITaskOutputStorage, outputCompression? }. Two READMEs still showed the old { tabularRepository: ... } form, which would no longer compile when users copy-paste them.
  • Replaced the eight stale TaskOutputTabularRepository constructor calls across packages/task-graph/README.md and packages/task-graph/src/storage/README.md with the new shape: storage: tabularTaskOutputStorage(<raw tabular storage>). The helper tabularTaskOutputStorage is already exported from @workglow/task-graph (via src/storage/TabularTaskOutputStorage.ts re-exported by src/common.ts).
  • Pulled tabularTaskOutputStorage into each example's @workglow/task-graph import block. Left every TaskGraphTabularRepository constructor untouched — that class still takes tabularRepository:.

Verification

# Every remaining `tabularRepository:` hit lives inside a `new TaskGraphTabularRepository({ ... })` block; zero inside TaskOutputTabularRepository.
grep -nB1 "tabularRepository:" packages/task-graph/README.md packages/task-graph/src/storage/README.md

# Confirms the helper is on the public surface.
grep -n "tabularTaskOutputStorage" packages/task-graph/src/common.ts packages/task-graph/src/storage/TabularTaskOutputStorage.ts

Test plan

  • grep -nB1 "tabularRepository:" packages/task-graph/README.md packages/task-graph/src/storage/README.md — every hit is preceded by new TaskGraphTabularRepository({.
  • Skim each touched code block in the rendered Markdown to confirm imports and constructor calls match.
  • Optional: copy one of the updated examples into a scratch TS file under packages/task-graph and confirm it type-checks against the current TaskOutputTabularRepository signature.

Generated by Claude Code

… new constructor signature

After commit c011234 removed the legacy `{ tabularRepository: ... }` option
shim, copy-paste from these README examples produced a TS error against the
new `{ storage: ITaskOutputStorage }` constructor signature. Replaced the
eight stale `tabularRepository:` constructor calls across two READMEs with
`storage: tabularTaskOutputStorage(...)` and pulled the helper into each
example's import block.
@sroussey sroussey merged commit bc0918d into main Jun 10, 2026
20 of 22 checks passed
@sroussey sroussey deleted the claude/beautiful-mayer-Mqpl3 branch June 10, 2026 00:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants