Document depth option for shallow git clones #27383
Open
Conversation
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
agents-git-bot
bot
requested review from
a team,
ghostwriternr and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
Add comprehensive documentation for the new depth parameter in gitCheckout(): - Enhanced Files API reference with detailed parameter description, return type, and validation rules - Added examples showing shallow clones with depth: 1 for latest commit only - Added example combining branch, depth, and targetDir options - Updated git-workflows guide with realistic repository examples (linux kernel, react) - Enhanced best practices section with guidance on when to use shallow clones Synced from cloudflare/sandbox-sdk PR #326
agents-git-bot
bot
force-pushed
the
sync-docs-pr-326
branch
from
0650538 to
ead09b7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 Sync for PR #326
Syncs documentation for the new
depthparameter ingitCheckout()method from cloudflare/sandbox-sdk#326.Changes
Files API Reference (
/sandbox/api/files/)depthparameter (positive integer for shallow clones)GitCheckoutResultwith all fieldsdepth: 1using realistic repo (torvalds/linux)Git Workflows Guide (
/sandbox/guides/git-workflows/)depth: 1clones only latest commitBenefits
This documentation helps users:
depth: 1vs higher valuesRelated SDK PR: cloudflare/sandbox-sdk#326