docs(readme): note git-lfs requirement for full clones#423
Merged
jrusso1020 merged 3 commits intomainfrom Apr 22, 2026
Merged
Conversation
Repo uses Git LFS for regression-test baselines (~240 MB of .mp4 files under packages/producer/tests/**/output.mp4). Users cloning without git-lfs installed hit a cryptic 'git-lfs: command not found' error, as reported in #407. Document the requirement with install instructions and the GIT_LFS_SKIP_SMUDGE=1 escape hatch.
miguel-heygen
approved these changes
Apr 22, 2026
Drive-by to unblock CI. Landed unformatted in #422 because Renovate's config-migration PR bypasses the lefthook pre-commit hook, so every subsequent PR's `bun run format:check` (which scans the whole repo) was failing on this file.
jrusso1020
added a commit
that referenced
this pull request
Apr 22, 2026
jrusso1020
added a commit
that referenced
this pull request
Apr 22, 2026
* ci: skip PR runs when targeting a non-main base branch Adds `branches: [main]` to the `pull_request:` trigger of each workflow that runs on PRs (CI, regression, Windows render verification, Docs, Catalog Previews). PRs whose base is something other than main — typical for stacked PRs — no longer trigger these workflows. On a 5-PR Graphite stack this turns 5× CI runs into 1× (when the tip of the stack reaches main). When a child PR is rebased/promoted so its base becomes main, CI fires as normal. publish.yml and the default CodeQL setup are untouched: publish already filters to main, and CodeQL is default-setup (org UI, not a repo YAML). * chore(ci): fix oxfmt formatting on renovate.json Same drive-by as #423. Renovate's config-migration PR #422 landed unformatted (Renovate bot skips lefthook), so every PR branched from current main fails `bun run format:check`. Whichever of #423 / #426 merges first cleans it up.
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
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.
What
Adds a "Cloning the repo" subsection under Contributing in the README, explaining the Git LFS requirement and the
GIT_LFS_SKIP_SMUDGE=1workaround.Why
Reported in #407. The repo uses Git LFS for ~240 MB of regression-test baselines under
packages/producer/tests/**/output.mp4. Users cloning withoutgit-lfsinstalled hit a cryptic error:The
skills add heygen-com/hyperframesinstall path hits the same wall, because that command does a full clone under the hood.Note: a proper code-level fix for the
skillsCLI is in progress upstream — this README note covers direct-clone contributors and anyone on askillsversion that doesn't yet ship that fix.How
Added a short subsection with:
brew) and Debian/Ubuntu (apt)GIT_LFS_SKIP_SMUDGE=1 git cloneescape hatch for users who only need the source filesTest plan
GIT_LFS_SKIP_SMUDGE=1 git clonesucceeds and leaves LFS files as pointer files, which is the expected behavior for anyone not running the regression suiteRefs #407