docs: clone with --depth 1: the newest commit only, and how to get the history when you need it #41

Merged
HumanBean merged 1 commit from HumanBean/LongshotLauncher:docs/shallow-clone into main 2026-11-13 14:47:03 +00:00
Owner

On release day, git clones were one of the biggest loads on git.magicbean.dev, whose upload link was saturated. The build-from-source instructions now clone the newest commit only (--depth 1). The same change is in Longshot's PR 214.

What changed

  • README.md, Build from source: git clone --depth 1 ….
  • CONTRIBUTING.md, Get started: the same, with jj's --depth 1, and one line on what needs the history (git log past it, cutting a release with scripts/release.py) and how to get it: git fetch --unshallow --tags.

Measured

A shallow clone of LongshotLauncher is 2.0 MB of .git against 2.2 MB for the full history (the repository's packs on the server). This repository is small, so the saving here is small; the change is for consistency with Longshot, where a shallow clone is about half the download (17 MB against 36 MB).

Testing

  • git clone --depth 1 of this repository from git.magicbean.dev: 2.0 MB, as above. I didn't build from that clone; the build doesn't read git (LongshotTag is passed in).
  • python -I tests/test_launcher_core.py --longshot <Longshot checkout>: 635 checks passed. python -I tests/test_release.py: OK.
  • jj 0.47 has jj git clone --depth.

🤖 Generated with Claude Code

On release day, git clones were one of the biggest loads on git.magicbean.dev, whose upload link was saturated. The build-from-source instructions now clone the newest commit only (`--depth 1`). The same change is in Longshot's [PR 214](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/214). ## What changed - `README.md`, *Build from source*: `git clone --depth 1 …`. - `CONTRIBUTING.md`, *Get started*: the same, with jj's `--depth 1`, and one line on what needs the history (`git log` past it, cutting a release with `scripts/release.py`) and how to get it: `git fetch --unshallow --tags`. ## Measured A shallow clone of LongshotLauncher is 2.0 MB of `.git` against 2.2 MB for the full history (the repository's packs on the server). This repository is small, so the saving here is small; the change is for consistency with Longshot, where a shallow clone is about half the download (17 MB against 36 MB). ## Testing - `git clone --depth 1` of this repository from git.magicbean.dev: 2.0 MB, as above. I didn't build from that clone; the build doesn't read git (`LongshotTag` is passed in). - `python -I tests/test_launcher_core.py --longshot <Longshot checkout>`: 635 checks passed. `python -I tests/test_release.py`: OK. - jj 0.47 has `jj git clone --depth`. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
docs: clone with --depth 1: the newest commit only, and how to get the history when you need it
All checks were successful
CI / Compile and test (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 4s
75cf10cf4e
Co-Authored-By: Claude Opus 5.5 <[email protected]>
HumanBean deleted branch docs/shallow-clone 2026-11-13 14:47:03 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/LongshotLauncher!41
No description provided.