docs(cli): document --build-timeout unit suffixes and deno.json precedence - #3484
Conversation
avocet-bot
left a comment
There was a problem hiding this comment.
Review: #3484 — docs(cli): document --build-timeout unit suffixes and deno.json precedence
Reviewed head SHA: 76c91cc30f8e13e505d8938f70e21279505f8b90
Verdict: Approve — no blocking issues. One optional style nit.
What this PR changes
runtime/reference/cli/deploy.md is the CLI reference page for the deno deploy
command (served at /runtime/reference/cli/deploy/). It is a static documentation
page — there is no executable code here, so "correctness" means: does the prose
accurately describe the shipped CLI behavior, do internal links/anchors resolve,
and is the page internally consistent?
The PR brings the reference in line with Deploy CLI 0.0.9908 and makes three edits
(+10 / −4, single file):
- deno.json precedence note (new paragraph under "Build configuration
options",deploy.md:70-74): states that if the app directory's
deno.json/deno.jsoncsets build configuration in itsdeploysection, that
takes precedence over the corresponding CLI options on every deploy, with a link
to the Builds reference page (ships with deploy-cli#146). --build-timeoutsyntax (deploy.md:107-108): the placeholder changes from
<minutes>to<duration>and the description now documents the accepted unit
suffix (10,10m,600s) alongside the plain-minute form (ships with
deploy-cli#147).- Wizard step 7 (
deploy.md:127-128): notes the interactive build-timeout
prompt is skipped when you accept a build configuration auto-detected from
deno.json/deno.jsonc.
Plus a last_modified front-matter bump to 2026-10-01.
Verification performed
I checked the repo out at the reviewed head SHA (76c91cc) and verified the
checkable claims within the docs repo:
- Internal link + anchor resolves (confirmed). The new link targets
/deploy/reference/builds/#editing-app-configuration-from-source-code. The file
deploy/reference/builds.mdexists at this SHA and contains the heading
### Editing app configuration from source code(builds.md:142). This repo
generates slug anchors by lowercasing, replacing spaces with hyphens, and
stripping punctuation, which yields exactly
editing-app-configuration-from-source-code— an exact match. A sibling heading
### Editing app configuration in the dashboard(builds.md:83) produces a
different slug, so there is no anchor collision and no-1disambiguation
suffix. Link is good. - Cross-page consistency (confirmed). The new unit-suffix syntax is corroborated
by the link target's own example ("buildTimeout": "15m", builds.md:245), so the
two pages agree. builds.md:170 further notesdeploy.buildTimeoutonly takes
effect together with at least one other build option; the new precedence
paragraph phrases precedence generically and defers specifics to the linked page,
which is reasonable for an overview flag reference and does not contradict
anything on either page. - Internal consistency (confirmed). The new precedence paragraph
(deploy.md:70-74) and the wizard step-7 note (deploy.md:127-128) agree — both
describe deno.json build config superseding CLI/wizard build options. No
contradiction. - Flag names / examples (confirmed).
--build-timeout,--build-memory-limit,
--regionare spelled correctly. The existing--build-timeout 5/10examples
elsewhere in the file (e.g. deploy.md:152, 592) remain valid under the broadened
"minutes or unit suffix" wording.
Findings
Non-blocking (style nit) — deploy.md:108. The revised allowed-values list is
written as bare numbers: Allowed values: 5, 10, 15, 20, 25 or 30 minutes. Every
sibling bullet in the same list still wraps values in backticks — --build-memory-limit
(`1024`, `2048`…, deploy.md:109-110) and --region (`us`, `eu`,
`global`, deploy.md:111) — and the pre-PR --build-timeout line used backticks
too. The edited line is now the lone formatting outlier. This renders fine and is
purely cosmetic, not a correctness issue. Optional: restore backticks, e.g.
`5`, `10`, `15`, `20`, `25` or `30` minutes.
No broken links, no dead anchors, no wrong flag names, no factual contradictions
within the docs were found.
Review skill evidence
- Invoked the
pr-review-toolkit:code-reviewersubagent (via the Task/Agent tool)
to perform the primary docs-focused review of the diff and link anchor. - Independently re-verified the subagent's key claim (link target file + heading →
anchor slug) against a fresh clone of denoland/docs checked out at head SHA
76c91cc30f8e13e505d8938f70e21279505f8b90, and confirmed the line anchors cited
above.
Conclusion: Accurate, well-scoped documentation update; the one new internal
link resolves correctly and the page is internally consistent. Safe to merge. The
backtick-consistency nit at deploy.md:108 is optional.
Updates the
deno deployCLI reference for deploy CLI 0.0.9908:--build-timeoutaccepts a unit suffix (10m,600s) as well asminutes (feat(create): accept --build-timeout with a unit suffix deploy-cli#147)
deploysection takes precedence over thecorresponding build options on every deploy, now that the CLI sends it
(feat(deploy): send deno.json to the console on every deploy deploy-cli#146); the wizard skips the timeout prompt when
such a detected configuration is accepted