Skip to content

docs(zsh-lint): sync generated reference - #950

Merged
ss-o merged 1 commit into
mainfrom
docs/zsh-lint-reference
Oct 25, 2026
Merged

ss-o merged 1 commit into
mainfrom
docs/zsh-lint-reference

Conversation

@z-shell-wiki-docs-sync

Copy link
Copy Markdown
Contributor

Automated reference sync from z-shell/zsh-lint.
Generated from published rule documentation. Do not hand-edit the marked region.
Published source: v1.6.1
Source commit: 136df813e37d0ec48573929489b44c1841af57ee
Refs z-shell/zsh-lint#750

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9a5d40e
Status: ✅  Deploy successful!
Preview URL: https://0a77ef50.zsh.pages.dev
Branch Preview URL: https://docs-zsh-lint-reference.zsh.pages.dev

View logs

@ss-o ss-o left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fallback review under ADR-0026: Copilot request not registered on 9a5d40e

Sole-maintainer exception

The maintainer elected the ADR-0035 sole-maintainer exception for this pull request at head 9a5d40e. No second human reviewer is available, and the configured Copilot request on this head did not register (requested 2026-10-24T18:38:13Z, no review_requested event for Copilot, requested_reviewers empty; cause unconfirmed). A new head voids this election and this review.

Findings

No actionable findings.

Scope: the complete diff, community/04_zsh_lint/08_rule_reference.mdx with 8 lines changed, generated from the published z-shell/zsh-lint v1.6.1 release (z-shell/zsh-lint#751).

Note

This fallback review and the exact-head review below are not a human review or an approval to merge.

Exact-head read-only review

A read-only exact-head review of this commit, in its own reviewing session, reported no actionable findings. Its evidence:

  • Running the sync workflow's commands on a git archive of v1.6.1 (go tool gomarkdoc over ./internal/rules, then go run ./cmd/wikidoc -mode rules against this repository's main) produces a file byte-identical to the head file.
  • The 7 rule-text changes are the v1.6.0 to v1.6.1 doc-comment changes from z-shell/zsh-lint#748 and z-shell/zsh-lint#750, verbatim. Spot checks against the implementation agree: builtin local ZSH_VERSION=1 and noglob typeset OSTYPE=x are reported, typeset -p stays silent, the new ordinary-call paths only add findings, and single-element subscripts get scalar advice while ranges, reverse and chained subscripts keep the selection. go test ./internal/rules passes on the v1.6.1 tree.
  • Only the generated region changes, and the markers, admonition and commit link are intact.

Validation

  • Passed on the head: every pull-request check (CodeQL, Validate Corpus, Trunk Code Quality, Org Routing, the four Policy checks and the Cloudflare Pages preview build); merge state is clean.
  • Reproduced for this review: the same regeneration from v1.6.1 against main gives a byte-identical file. All 8 hunks lie between zsh-lint:generated:start (line 21) and zsh-lint:generated:end (line 523). The :::info notice names v1.6.1 at 136df81, the release's tag commit, and no v1.6.0 text remains in the generated region. The single sync commit is signed and GitHub reports it verified.
  • Unavailable: rendered-page inspection at desktop and narrow widths.

Limits and follow-up

  • The phrase "after precommand modifiers" is slightly broad: command is excluded, correctly, because Zsh's command runs an external command. That wording belongs to the zsh-lint rule documentation, not this generated page.
  • The reader guide's move to v1.6.1 is tracked separately in #949.

@ss-o ss-o left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fallback review under ADR-0026: Copilot request not registered on 9a5d40e

This review replaces the earlier fallback review on this head, which did not record the checklist verdicts or a recovery plan. The head, the election and the request history are unchanged.

Sole-maintainer exception

The maintainer elected the ADR-0035 sole-maintainer exception for this pull request at head 9a5d40e. No second human reviewer is available, and the configured Copilot request on this head did not register (requested 2026-10-24T18:38:13Z, no review_requested event for Copilot, requested_reviewers empty; cause unconfirmed). A new head voids this election and this review.

Findings

No actionable findings on the diff.

Scope: the complete diff from main at a12a1cb, the head's only parent, to 9a5d40e: community/04_zsh_lint/08_rule_reference.mdx, 8 lines changed, generated from the published z-shell/zsh-lint v1.6.1 release (136df81, z-shell/zsh-lint#751).

Note

This fallback review and the exact-head review below are not a human review or an approval to merge.

Exact-head read-only review

A read-only exact-head review of this commit, in its own reviewing session using the organization code-review skill and checklist, reported no confirmed defects. Its evidence:

  • Regenerating the reference offline from a git archive of v1.6.1 with the sync workflow's commands (go tool gomarkdoc over ./internal/rules, then go run ./cmd/wikidoc -mode rules against main at a12a1cb) produces a file byte-identical to the head file. This was also reproduced for this review.
  • All 8 changed lines sit between the single zsh-lint:generated:start and zsh-lint:generated:end markers; frontmatter, headings, anchors and code fences are unchanged.
  • The 7 rule-text changes are the v1.6.0 to v1.6.1 doc-comment changes from z-shell/zsh-lint#748 and z-shell/zsh-lint#750, and they agree with the implementation: declarations after builtin, noglob, - and nocorrect are recognized for reporting only and never suppress later findings, and quoting/unquoted-var gives scalar advice for a single-element subscript while ranges, reverse and chained subscripts keep the selection.
  • It raised one traceability question, on pull-request metadata rather than the diff; see Follow-up.

Validation

  • Passed on the head: all 12 pull-request checks, including Branch Name, Issue Link, PR Title, Commits, Trunk Code Quality, CodeQL, Org Routing, Validate Corpus and the Cloudflare Pages preview build. No review threads are open.
  • Reproduced for this review: the offline regeneration above, byte-identical.
  • Unavailable: a local Docusaurus build and rendered-page inspection; the Cloudflare Pages preview build on this head is the build evidence. The zsh-lint test results are those of the v1.6.1 release qualification on z-shell/zsh-lint#751.
Checklist verdicts and supporting evidence
  • Accuracy against the source: pass. The regenerated file is byte-identical, and the changed sentences match the v1.6.1 doc comments and the rule implementation listed above.
  • Generated-content ownership and scope: pass. Only the marked generated region of the rule reference changes. Corrections belong in the zsh-lint doc comments or generator, followed by a new sync, not in hand edits here.
  • MDX validity and rendering: pass. The changes add prose and inline code only, with no new JSX, imports, images, headings or fences, and the info admonition stays intact. The preview build compiled the page.
  • Links: pass. The only changed link is the source commit, which matches the v1.6.1 tag commit. Rule headings and anchors are unchanged.
  • Supply chain and trust boundaries: pass. The sync builds from the published release tag; its actions are pinned to full commits, workflow permissions are read-only, the app token is limited to wiki contents and pull requests, and the commit is signed and verified. Byte equality shows the file is reproducible from the release; it does not show which generator revision the hosted run used.
  • Failure paths: pass. The generator rejects malformed versions and commits, empty or duplicate rules and missing markers before writing.
  • Deployment: pass. A merge to main runs the production build and publishes the site to Cloudflare Pages only after the build succeeds. It changes the rule-reference page and the generated corpus output, and installs nothing for readers.
  • Traceability: no blocker. The body refers to z-shell/zsh-lint#750, the pull request that closed z-shell/zsh-lint#688 and the last change in the release, and the required Issue Link check passes. See Follow-up.

Limits and recovery

  • Unavailable: a local Docusaurus build and rendered-page inspection at desktop and narrow widths.
  • Recovery: if the deployed reference is wrong after merge, revert the squash commit on main; the previous reference returns with the next successful build and deployment. A later sync from the same release would bring the text back, so a wrong statement is fixed in the zsh-lint doc comments first.
  • Deployment is verified on the merged main commit, separately from this review.

Follow-up

  • The sync body refers to the last merged zsh-lint pull request rather than to an issue. Referring to the release issue (here z-shell/zsh-lint#751) would make the owning record explicit. This is a property of the sync workflow, shared by earlier sync pull requests, and is not part of this diff.

@ss-o
ss-o merged commit 889ec9d into main Oct 25, 2026
12 checks passed
@ss-o
ss-o deleted the docs/zsh-lint-reference branch October 25, 2026 00:36
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.

1 participant