[docs] Update documentation for features from 2026-06-02#36440
Closed
github-actions[bot] wants to merge 1 commit into
Closed
[docs] Update documentation for features from 2026-06-02#36440github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…tmatter fields Add curated reference entries for two top-/runtime-level frontmatter fields that were previously only present in the auto-generated frontmatter-full.md: - check-for-updates (top-level, default true) — activation-job version check - runtimes.<runtime>.run-install-scripts (default false) — now the only valid form after the top-level field was removed (#36387) Both headings use the field-name slug so the in-schema anchor links (#check-for-updates, #run-install-scripts) resolve to real headings, addressing the still-present gap tracked in #36275. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
|
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 Updates - 2026-06-02
This PR documents two frontmatter fields that existed in the JSON Schema but had no entry in the curated frontmatter reference, and aligns them with recent code changes from the last 24 hours.
Features Documented
check-for-updates(top-level, defaulttrue) — controls the compile-time version update check in the activation job. Previously undocumented in curated docs.runtimes.<runtime>.run-install-scripts(defaultfalse) — now the only valid form for this field after the top-level variant was removed in Remove deprecated top-levelrun-install-scriptsfrontmatter field #36387. Documented under the existing Runtimes section.Both new headings use the bare field-name slug so the in-schema anchor links (
#check-for-updates,#run-install-scripts) emitted inmain_workflow_schema.jsondescriptions now resolve to real headings.📝 Detailed Changes & References
Changes Made
docs/src/content/docs/reference/frontmatter.md:check-for-updatesreference section after Strict Mode, describing the default-on activation-job version check and the strict-mode restriction.run-install-scriptssubsection inside the Runtimes section, documenting the per-runtime supply-chain install-script opt-in, its compile-time warning / strict-mode error, and noting that the removed top-level form must now be configured under a runtime block.Triggering Code Change
run-install-scriptsfrontmatter field #36387 — Remove deprecated top-levelrun-install-scriptsfrontmatter field. The field is now valid only underruntimes.*; the docs were updated to reflect the runtime-scoped model.Pre-existing Gap Addressed
[deep-report] [quick-win] Document 3 undocumented top-level frontmatter fields + fix broken in-schema anchors) was closed as completed, but a direct content check showedcheck-for-updatesandrun-install-scriptswere still absent from the curated reference and their in-schema anchors were still broken. This PR resolves both. (Issue already closed; not re-closing via keyword.)Last-24h merged PRs reviewed (no user-doc change required)
-1#36392 — daily ET guardrail emission made default-on with runtime gating; the user-facing contract ("disabled when omitted", "-1disables") is unchanged, so existing docs infrontmatter.md/compiler-enterprise-environment-controls.mdremain accurate.run-install-scriptsfrontmatter field #36387 — top-levelrun-install-scriptsremoval (documented here).applyTofrom parser validFields allowlist #36309 — removedpermissions.copilot-requests: writerecommendation / vestigialapplyTo: no remaining recommendation or workflow-frontmatter usage in curated docs.timeout-minutesa templatable integer in schema + custom job compilation #36314 —timeout-minutesmade a templatable integer (schema/compiler internal; expression usage already implied by templatable-integer docs).push_to_pull_request_branchbehavior for multi-checkout workflows #36238 —push_to_pull_request_branchmulti-checkout clarification was an agent-prompt file change, not user docs.Skipped Issues
disable-model-invocation: the third field named in this issue is left undocumented in this run. Its schema description ("Controls whether the custom agent should disable model invocation") is ambiguous about scope and behavior, and it has no broken anchor link to fix. Documenting it accurately needs maintainer clarification rather than a guessed description.compile --workflow-namevs--workflows: the incorrect flag appears only in an internal workflow-prompt example (Daily CLI Tools Tester), not in user-facing docs underdocs/src/content/docs/. No curated-doc change applies.Notes
### \check-for-updates`,#### `run-install-scripts`) rather than the page's usual descriptive### Name (`field:`)style. This is required so the heading slugs exactly match the#check-for-updates/#run-install-scriptsanchors hard-coded in the schema descriptions. If maintainers prefer descriptive headings, the alternative is a one-line update to theSee:links inpkg/parser/schemas/main_workflow_schema.json(plus a regeneration of the generatedfrontmatter-full.md`), which was kept out of scope for this docs-only run.