feat: add private-repo support to CLI & core (UI coming next) #282
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
…cs/CLI * Run `git sparse-checkout set …` and `git checkout <sha>` as two calls—matches Git’s CLI rules and fixes failures. * Tidy clone path creation via _ensure_directory; use DEFAULT_TIMEOUT. * Clarify CLI/help strings and schema docstrings. * Update tests for the new two-step checkout flow.
* CLI: new `--token/-t` flag (fallback to `GITHUB_TOKEN`) * clone_repo: * injects Basic-auth header when a PAT is supplied * validates PAT format (`github_pat_*`) * git_utils: * `create_git_auth_header`, `validate_github_token`, `create_git_command` * `_check_github_repo_exists` & branch-listing now work with tokens * os_utils.ensure_directory extracted for reuse * tests updated to reflect new call signatures
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces private repository support and fixes issues with sparse-checkout usage by updating command invocations, token handling, and associated utilities. Key changes include adding token parameters to functions (e.g. check_repo_exists, clone_repo, etc.), adjusting CLI options to accept a GitHub PAT, and refactoring git command construction for cloning and checkout processes.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_repository_clone.py | Updated test expectations to reflect the new token parameter for repo existence checks. |
| src/gitingest/utils/os_utils.py | Added a helper to ensure directories exist before operations. |
| src/gitingest/utils/git_utils.py | Enhanced functions to include token-based authentication and support private repo checks via GitHub API. |
| src/gitingest/schemas/ingestion_schema.py | Added a new blob field to the clone configuration schema. |
| src/gitingest/query_parsing.py | Updated parsing functions to support token passing for handling private repos. |
| src/gitingest/entrypoint.py | Introduced token handling in both async and synchronous entry points. |
| src/gitingest/config.py | Added a DEFAULT_TIMEOUT constant for consistent timeout handling. |
| src/gitingest/cloning.py | Updated clone_repo to handle token validation, authentication and split sparse-checkout/commit checkout commands. |
| src/gitingest/cli.py | Extended CLI options to include token support and improved help messages for clarity. |
filipchristiansen
force-pushed
the
feat/private-repo-support
branch
from
75131b5 to
e8156a9
Compare
cyclotruc
approved these changes
Jun 15, 2025
Member
cyclotruc
left a comment
cyclotruc
left a comment
There was a problem hiding this comment.
Tested and the changes seem very reasonable to me, thank you
This was referenced Jun 16, 2025
|
Hi @cyclotruc - is there plans for this change be released out through pypi anytime soon? |
Member
|
@ChrisCarini this has just been released! |
Awesome, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Private-repo support & sparse-checkout fix
This PR enables Gitingest to ingest private GitHub repositories and resolves the long-standing sparse-checkout CLI mismatch.
✨ New Features
--token/-tflag (withGITHUB_TOKENenv-var fallback) to supply a GitHub PAT.http.https://github.com/.extraheader=Authorization: Basic …when a PAT is present.• Validates PAT format (
github_pat_*, orgph_*).• Fully supports partial clones and commit pins.
check_repo_existsand branch-listing now hit the GitHub REST API with auth when required.🐛 Fixes & clean-ups
🧪 Tests
🗒️ Usage
or:
No breaking changes — public-repo workflows continue to work as before.