docs(providers): fix binaries example and archive checksum docs by skevetter · Pull Request #1600 · devsy-org/devsy

skevetter · 2026-10-19T22:19:40Z

Summary

Docs-only fix to sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx (23 added, 2 removed lines vs origin/main).

Archive extraction applies only when path is an http:// or https:// URL. Local archive paths are copied, not extracted.
name is ignored for HTTP(S) archives.
checksum is optional, except for the agent.binaries entry selected by agent.external.binary, which requires SHA-256 for every platform. Links to the External Driver section.
Checksum is computed over the file Devsy runs. For HTTP(S) archives that is the extracted file at archivePath.

Why

Greptile review found earlier claims that did not match code:

pkg/provider/download.go: handleLocalBinary copies local files and does not extract archives. downloadArchive is reached only through downloadRemoteBinary.
pkg/provider/external.go: validateExternalLocations rejects missing or non-32-byte SHA-256 checksums for the external driver binary.

Removed claims: "archive itself is never hashed" (unscoped), "name has no effect on archives", and blanket "checksum is optional".

Validation

Run in sites/docs-devsy-sh on commit 8fe8ddc1c:

npm ci: exit 0.
npm run build: exit 0 (first run; no retry needed).
npm run check-links: exit 0, 0 errored file, 0 errors.

CodeRabbit CLI

coderabbit review --agent --committed --base-commit 2a0a20255ceb9f4e6c638b95c21311f556d8ba39 on 8fe8ddc1c: review_completed, findings: 0, reviewed file sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx. Earlier attempts were rate-limited; the successful run was after the reset. The earlier findings: 0 on 5c03a3e8b is superseded.

Auto-merge

Not enabled. Not merged. Not marked ready.

Layer / File(s)	Summary
Binary and archive configuration `sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx`	The basic example no longer includes `archivePath`. The documentation describes archive URL requirements, extraction behavior, and checksum verification, including failure on mismatch.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 8fe8d

No merge-blocking risk remains in the reviewed documentation.

Architecture Summary

Architecture risk: 🔵 Low · up to 8fe8d

The change affects 1 system.

Changed systems: sites

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

observed — sites (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

observed — Modified behavior in sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx: The basic binary example now treats name as optional and documents that checksum verification occurs only when checksum is set.
observed — Modified behavior in sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx: Added archive usage documentation: HTTP(S) archive paths use the file extension to select extraction format, require archivePath, extract while preserving archive layout, and ignore name; setting archivePath on a direct binary URL fails with an unrecognized archive format.
observed — Modified behavior in sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx: Added checksum semantics: checksums are generally optional but required for the selected external agent binary on every platform; Devsy hashes the executable that will run, compares case-insensitively, and deletes the file and fails without retry on mismatch.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Description check		The description clearly explains the documentation changes, rationale, validation commands, and review status. It does not follow several required template sections: it omits the issue reference, type…	Add the required template sections or equivalent information. State `Fixes #N`, `Refs #N`, or `none`; select `Docs`; complete the AI assistance and reviewer-attestation fields; state that no integration test is needed because this is docs-o…

Passed checks: 4 passed

Check name	Status	Explanation
Title check		The title clearly and concisely identifies the documentation fixes for provider binary examples and archive checksum behavior.
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description clearly explains the documentation changes, rationale, validation commands, and review status. It does not follow several required template sections: it omits the issue reference, type-of-change selection, AI assistance disclosure, checklist confirmations, and the explicit docs-only testing justification.

Resolution

Add the required template sections or equivalent information. State Fixes #N, Refs #N, or none; select Docs; complete the AI assistance and reviewer-attestation fields; state that no integration test is needed because this is docs-only; and complete the applicable checklist items.

Fix all pre-merge checks with AI

✨ Finishing Touches

✨ Simplify code

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

netlify · 2026-10-19T22:20:21Z

✅ Deploy Preview for images-devsy-sh canceled.

Name	Link
🔨 Latest commit	`8fe8ddc`
🔍 Latest deploy log	https://app.netlify.com/projects/images-devsy-sh/deploys/6ad6d0f1f2193c15dac408a7

skevetter · 2026-10-20T02:11:21Z

@greptileai review

mergify · 2026-10-20T02:11:55Z

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

greptile-apps · 2026-10-20T02:14:20Z

Confidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Summary

Updates binaries.mdx to match how Devsy downloads and checks provider binaries.

Provider binary docs explain when Devsy extracts archives and which file it uses.
Provider binary docs explain when checksums are optional, required, and checked.

_{Reviews (2) · Last reviewed commit: "docs(providers): scope archive and check..." · Reviewed by Greptile}

skevetter · 2026-10-20T02:15:27Z

Both Greptile clarifications are valid against downloadBinary/handleLocalBinary and validateExternalLocations. A docs-only follow-up is in progress to scope remote archive behavior and document the external-driver checksum requirement.

skevetter · 2026-10-20T02:46:34Z

@greptileai review

skevetter · 2026-10-20T02:59:37Z

@coderabbitai full review

coderabbitai · 2026-10-20T02:59:43Z

⚠️ Action not completed

Review rate limited.

Your included review limit is currently reached under our Fair Usage Limits Policy. This review may still proceed through usage-based billing if eligible. Your next included review will be available in 55 seconds.

skevetter · 2026-10-20T03:02:53Z

@coderabbitai full review

coderabbitai · 2026-10-20T03:02:59Z

✅ Action performed

Full review finished.

skevetter · 2026-10-20T03:08:42Z

CodeRabbit description warning disposition: this automated docs-only PR uses the maintenance skill template. Issue: none. Type: Docs. AI assistance: Haiku authored the correction; coordinator checked each changed claim against provider parsing/download/external-driver code. No human reviewer attestation is claimed. Site build and link checks passed; integration tests are not applicable to this content-only diff. Final-head CLI review has zero findings, GitHub full review completed with no actionable comments, and Greptile is 5/5.

skevetter added the docs-cleanup Docs cleanup (maintenance bot) label Oct 19, 2026

github-actions Bot added the size/xs label Oct 19, 2026

docs(providers): sync main for binary documentation

5c03a3e

skevetter marked this pull request as ready for review October 20, 2026 02:11

greptile-apps Bot reviewed Oct 20, 2026

View reviewed changes

Comment thread sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx Outdated

Comment thread sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx Outdated

docs(providers): scope archive and checksum rules to code behavior

8fe8ddc

skevetter merged commit 9e73e8a into main Oct 20, 2026
37 checks passed

skevetter deleted the docs/provider-binaries-download-example branch October 20, 2026 03:08

Conversation

skevetter commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why

Validation

CodeRabbit CLI

Auto-merge

Next

Uh oh!

netlify Bot commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for devsydev ready!

Uh oh!

coderabbitai Bot commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Architecture Summary

Uh oh!

netlify Bot commented Oct 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for images-devsy-sh canceled.

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

mergify Bot commented Oct 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps Bot commented Oct 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Confidence Score: 5/5

Summary

Uh oh!

Uh oh!

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

coderabbitai Bot commented Oct 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

coderabbitai Bot commented Oct 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skevetter commented Oct 20, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

skevetter commented Oct 19, 2026 •

edited

Loading

netlify Bot commented Oct 19, 2026 •

edited

Loading

coderabbitai Bot commented Oct 19, 2026 •

edited

Loading

netlify Bot commented Oct 19, 2026 •

edited

Loading

mergify Bot commented Oct 20, 2026 •

edited

Loading

greptile-apps Bot commented Oct 20, 2026 •

edited

Loading

coderabbitai Bot commented Oct 20, 2026 •

edited

Loading

coderabbitai Bot commented Oct 20, 2026 •

edited

Loading