Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

perf: --depth=1 shallow clone for end users #203

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

agilgur5
Copy link

Summary

Speed up downloads of the script with a more efficient shallow clone

Details

  • rather than cloning the entire history of the repo, can do a shallow clone with a depth of 1

    • this should make it more efficient, particularly when there are many commits or many large commits
    • since the history is unused by regular end users, there is no need to fetch/download it
  • also add syntax highlighting to the first code block, matching the second one

Notes to Reviewers

  • could alternatively do a bare clone to be even more efficient
    • but I thought a shallow clone is a bit less intrusive for now
      • and is reversible, if needed (i.e. a local shallow clone can fetch the rest of the depth)

References

This is largely equivalent to ryanrudolfoba/SteamOS-Waydroid-Installer#198

- rather than cloning the entire history of repos, can do a shallow clone with a [depth](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt-code--depthcodeemltdepthgtem) of 1
  - this should make it more efficient, particularly when there are many commits or many large commits
  - since the history is unused by regular end users, there is no need to fetch/download it

- could alternatively do a [bare](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt-code--barecode) clone to be even more efficient
  - but I thought a shallow clone is a bit less intrusive for now
    - and is reversible, if needed (i.e. a local shallow clone can fetch the rest of the depth)

- also add syntax highlighting to the first code block, matching the second one
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