docs: correct and expand the .tembo.json hooks reference - #694
Open
tembo[bot] wants to merge 1 commit into
Open
Conversation
Verified against apps/api/src/agent/sandbox/temboConfig.ts and its call sites: - Flag that prePush is parsed but never executed (both call sites in solve_issue/feedback_loop are commented out and both tasks are disabled stubs) - Document that setupScript is skipped when a session restores an existing workspace (snapshot/resume), and that snapshots must be rebuilt after changing setup commands - Document the tembo.nix dev-shell wrapping and pre-baked-deps fast path - Document the postClone legacy alias and setupScript precedence - Document parse-failure fallback to defaults and silently ignored unknown keys - Cross-link the snapshot setup script vs the .tembo.json hook
tembo
Bot
requested review from
Coleary005,
DarrenBaldwin07 and
benja
as code owners
August 14, 2026 08:08
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Requesting review from @DarrenBaldwin07 who has experience with the following files modified in this PR:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only update to
features/hooks.mdx, verified line-by-line againstapps/api/src/agent/sandbox/temboConfig.tsand every one of its call sites.prePushis documented but never runsThe most significant finding.
features/hooks.mdxcurrently tells users:That does not happen in the current code:
prePushis still accepted and validated byTemboConfigSchema(temboConfig.ts:15).runHook('prePush', ...)call sites are commented out —solve_issue/index.ts:742andfeedback_loop/index.ts:771."<task> task is disabled"(~95% of each file is commented out).agent_run, only callsrunHook('setupScript')(agent_run/index.ts:404).prepare.ts:269likewise runs onlysetupScript.packages/agent-runtimeruns hooks at all.So a user who puts lint/test commands in
prePushbelieves pushes are gated when they are not. I documented the actual behavior with a warning and removedprePushfrom the main example so we are not shipping a non-functional sample. If this is a temporary disablement with a fix landing soon, say so and I will reword to "temporarily disabled" instead.Other corrections and additions
setupScriptis skipped when a session restores an existing workspaceagent_run/index.ts:402,sandboxTask.ts:216-229setupScriptalso runs during snapshot buildsqemu/prepare.ts:268tembo.nixdev shell; pre-baked golden deps use a saved PATH insteadtemboConfig.ts:81-135postCloneis a legacy alias forsetupScript, andsetupScriptwins when both are settemboConfig.ts:11-20,tests/sandbox/temboFlake.test.ts:96-122.tembo.jsonfalls back to defaults and continues silentlytemboConfig.ts:72-78setupScriptsis dropped without errortemboConfig.ts:25-30prepare.ts:270-277(noonCommandLoginagent_run)Docs added/updated
features/hooks.mdx— rewritten as an accurate reference: whensetupScriptruns and when it is skipped,tembo.nixinteraction, failure semantics (non-zero exit logs and continues), and a config reference table.features/snapshots.mdx— one<Note>distinguishing the Settings-configured snapshot setup script from the.tembo.jsonsetupScripthook.Key knowledge gaps addressed
setupScripthas no effect on sessions restoring from an existing snapshot until it is rebuilt. This was undocumented and is the most likely "my setup command is not running" support case..tembo.jsonand typo'd keys both degrade to "no hooks" with nothing surfaced in the session.No new pages, so
docs.jsonnavigation is unchanged. All internal links verified to resolve.Note
Low Risk
Documentation-only changes with no runtime, auth, or data-path impact.
Overview
Rewrites the Hooks docs so they match current product behavior instead of implying
prePushgates pushes.prePushis now called out with a warning: it is validated in.tembo.jsonbut not executed; the example no longer shows lint/test inprePush.setupScriptis documented for fresh clones and snapshot builds, and explicitly skipped when resuming or restoring from a snapshot, including the need to rebuild snapshots after hook changes.New sections cover
tembo.nixdev-shell behavior, failure handling (non-zero exits log and continue; use&&to fail fast), a configuration reference table (postClonealias, silent invalid JSON / ignored keys), and Related links. Snapshots gains a short note separating the Settings setup script from the.tembo.jsonsetupScripthook.Reviewed by Cursor Bugbot for commit 344bd2e. Bugbot is set up for automated code reviews on this repo. Configure here.