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
|
Preview URL: https://d8791fc8.preview.developers.cloudflare.com Files with changes (up to 15)
|
agents-git-bot
bot
force-pushed
the
sync-docs-pr-326
branch
2 times, most recently
from
ead09b7 to
8034e28
Compare
- Add shallow clone example with depth: 1 for large repositories - Improve parameter descriptions (default branch, targetDir format) - Show practical example using facebook/react repository Synced from cloudflare/sandbox-sdk PR #326
agents-git-bot
bot
force-pushed
the
sync-docs-pr-326
branch
from
8034e28 to
d8791fc
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.
Summary
This PR documents the new
depthoption forgitCheckout()that enables shallow cloning of Git repositories.Changes Made
sandbox/api/files.mdx):depth: 1for large repositoriesContext
This change syncs documentation with cloudflare/sandbox-sdk#326, which adds shallow clone support via
depthoption ingitCheckout(). Usingdepth: 1clones only the latest commit, reducing clone time and disk usage for large repositories.Note
The
git-workflows.mdxguide already included the depth option examples and did not require updates.🤖 Generated by automated documentation sync from cloudflare/sandbox-sdk#326