jacebrowning / jacebrowning/gitman
Add `recurse` option in config
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 225
- Forks
- 36
- Avg merge
- 15h 47m
- Merged PRs (30d)
- 8
Description
To avoid recursive clones when there are circular dependencies, `gitman install --depth 1` can be used. However, this is risky as it requires the user to add it on every `gitman install` call. It would be nice to have a `recurse` field in `gitman.yml` to provide a little more control.
For example:
```yaml
location: gitman_sources
sources:
- name: mydep
type: git
repo: https://someurl.com/mydep.git
recurse: false # Don't process the gitman.yml in the mydep repo
sparse_paths:
-
rev: master
link:
scripts:
-
groups:
-
```
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how `gitman install` reads `gitman.yml` and handles the existing `--depth 1` behavior. Add support for the shown per-source `recurse: false` setting, and verify that a source with this setting does not process its nested `gitman.yml` while normal sources continue to recurse.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- cli, devtools
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100