Skip to content

docs: Document turbo.* generator variables#12511

Merged
anthonyshew merged 1 commit intomainfrom
shew/add-generator-vars-docs
Mar 31, 2026
Merged

docs: Document turbo.* generator variables#12511
anthonyshew merged 1 commit intomainfrom
shew/add-generator-vars-docs

Conversation

@anthonyshew
Copy link
Copy Markdown
Contributor

Summary

  • Documents the turbo object that Turborepo injects into generator action answers (turbo.paths and turbo.configs), which was previously only discoverable by reading source code.
  • Adds a guide-level section to the Generating code page showing usage in both Handlebars templates and custom actions.
  • Adds a full reference table to the @turbo/gen page.

Closes #8708

Adds documentation for the turbo object that Turborepo injects into
generator action answers (turbo.paths and turbo.configs), which was
previously undiscoverable without reading source code.

Closes #8708
@anthonyshew anthonyshew requested a review from a team as a code owner March 31, 2026 15:07
@anthonyshew anthonyshew requested review from tknickman and removed request for a team March 31, 2026 15:07
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Mar 31, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
examples-basic-web Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-designsystem-docs Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-gatsby-web Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-kitchensink-blog Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-nonmonorepo Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-svelte-web Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-tailwind-web Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
examples-vite-web Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
turbo-site Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm
turborepo-agents Ready Ready Preview, Comment, Open in v0 Mar 31, 2026 3:09pm

@anthonyshew anthonyshew enabled auto-merge (squash) March 31, 2026 15:09
@anthonyshew anthonyshew merged commit aa014c7 into main Mar 31, 2026
39 checks passed
@anthonyshew anthonyshew deleted the shew/add-generator-vars-docs branch March 31, 2026 15:14
github-actions Bot added a commit that referenced this pull request Mar 31, 2026
## Release v2.9.2-canary.3

Versioned docs: https://v2-9-2-canary-3.turborepo.dev

### Changes

- fix(api-client): Treat * as wildcard in preflight
Access-Control-Allow-Headers (#12503) (`960b2eb`)
- release(turborepo): 2.9.2-canary.2 (#12510) (`d4d3f9d`)
- docs: Document `turbo.*` generator variables (#12511) (`aa014c7`)
- fix: Backfill missing pnpm workspace importer entries during prune
(#12514) (`45f2f43`)

Co-authored-by: Turbobot <turbobot@vercel.com>
github-actions Bot added a commit that referenced this pull request Mar 31, 2026
## Release v2.9.2

Versioned docs: https://v2-9-2.turborepo.dev

### Changes

- release(turborepo): 2.9.1 (#12498) (`4240dd4`)
- fix: Add retry logic to example update workflow push step (#12499)
(`00a4aae`)
- docs: Add documentation for cacheMaxAge and cacheMaxSize options
(#12500) (`5b65487`)
- feat(examples): Add Next.js + Elysia full-stack starter template
(#12414) (`1559d0f`)
- fix: Resolve correct nested bun lockfile versions during prune
(#12506) (`ee5bcbf`)
- Revert "fix: Avoid `setsid()` in PTY spawn to prevent macOS Gatekeeper
CPU spikes" (#12507) (`6c3b8a6`)
- release(turborepo): 2.9.2-canary.1 (#12508) (`2bebb91`)
- fix: Unblock `watch` loop so interruptible persistent tasks restart on
file changes (#12509) (`95ec9ed`)
- fix(api-client): Treat * as wildcard in preflight
Access-Control-Allow-Headers (#12503) (`960b2eb`)
- release(turborepo): 2.9.2-canary.2 (#12510) (`d4d3f9d`)
- docs: Document `turbo.*` generator variables (#12511) (`aa014c7`)
- fix: Backfill missing pnpm workspace importer entries during prune
(#12514) (`45f2f43`)
- release(turborepo): 2.9.2-canary.3 (#12515) (`59a42a5`)
- fix: Include transitive dependencies in engine graph pruning for
affected paths using Task Graph (#12516) (`8c88521`)
- release(turborepo): 2.9.2-canary.4 (#12518) (`aed2066`)
- chore: Update AI-generated response text for clarity (#12517)
(`4a4e661`)
- fix: Preserve shallow install strategy during npm lockfile pruning
(#12520) (`72577db`)

---------

Co-authored-by: Turbobot <turbobot@vercel.com>
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.

Docs: document turbo.* generator variables

1 participant