carvel-dev / carvel-dev/vendir

For faster sync, add option to only download a single branch

Open
#102 8 comments 4 reactions 0 assignees View on GitHub
carvel-accepted enhancement
Dominant language
Go
Stars
399
Forks
73
Avg merge
2h 53m
Merged PRs (30d)
2

Description

**Describe the problem/challenge you have**
Currently, `vendir` takes long time to clone a repository. If I am after files from a specific branch it takes long time and it downloads unnecessary stuff I don't care about.

**Describe the solution you'd like**

Add an option to
- specify cloning depth
- only clone single branch

```yml
apiVersion: vendir.k14s.io/v1alpha1
kind: Config
directories:
- path: docs/modules
contents:
- path: ROOT/partials
git:
url: https://github.com/openshift/openshift-docs
ref: rhacs-docs
single-branch: true
depth: 1
includePaths:
- modules/*
newRootPath: modules/
```

---
Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

Contributor guide

Open the contributing guide

Research direction

No implementation file or test is named. Start by tracing how vendir reads the YAML git source shown in the example and performs repository cloning; done means the configuration supports both depth and single-branch behavior while preserving existing git syncing.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, go
Domain
devops, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.