https://github.com/carvel-dev/vendir

Easy way to vendor portions of git repos, github releases, helm charts, docker image contents, etc. declaratively
https://github.com/carvel-dev/vendir

carvel declarative git hacktoberfest sync vendor ytt

Last synced: 2 days ago
JSON representation

Easy way to vendor portions of git repos, github releases, helm charts, docker image contents, etc. declaratively

• Host: GitHub
• URL: https://github.com/carvel-dev/vendir
• Owner: carvel-dev
• License: apache-2.0
• Created: 2019-12-16T03:40:13.000Z (almost 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-17T06:39:50.000Z (6 months ago)
• Last Synced: 2024-05-19T03:04:09.899Z (6 months ago)
• Topics: carvel, declarative, git, hacktoberfest, sync, vendor, ytt
• Language: Go
• Homepage: https://carvel.dev/vendir
• Size: 77.2 MB
• Stars: 263
• Watchers: 15
• Forks: 45
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md
  • Governance: GOVERNANCE.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        
![logo](docs/CarvelLogo.png)

[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7746/badge)](https://bestpractices.coreinfrastructure.org/projects/7746)

# vendir

- Website: [https://carvel.dev/vendir](https://carvel.dev/vendir)

- Slack: [#carvel in Kubernetes slack](https://slack.kubernetes.io)

- [Docs](https://carvel.dev/vendir/docs/latest/) with example workflow and other details

- Install: Grab prebuilt binaries from the [Releases page](https://github.com/carvel-dev/vendir/releases) or [Homebrew Carvel tap](https://github.com/carvel-dev/homebrew)

- Backlog: [See what we're up to](https://github.com/orgs/carvel-dev/projects/1/views/1?filterQuery=repo%3A%22carvel-dev%2Fvendir%22).

`vendir` allows you to declaratively state what should be in a directory. It can be used for vendoring software.

```bash

$ vendir sync # from a directory that contains vendir.yml

```

Features:

- Various sources

  - pull Git repositories ([examples/git](examples/git), semver tag resolution in [examples/versionselection](examples/versionselection))

    - including tag semver selection, GPG verification

  - pull Github releases ([examples/github-release](examples/github-release), semver tag resolution in [examples/versionselection](examples/versionselection))

  - pull HTTP asset ([examples/http](examples/http))

  - pull Docker image contents ([examples/image](examples/image))

  - pull Helm chart contents ([examples/helm-chart](examples/helm-chart))

  - ...let us know sources you'd like to see

- Keep only particular portions of pulled content via includePaths/excludePaths or newRootPath

- Override specific directory with a local directory source for quick development

- State which directories are manually managed

- Specify inline content for a directory

- Generates lock file

- Keep common legal files (LICENSE, etc.)

See [all examples](examples/).

### Join the Community and Make Carvel Better

Carvel is better because of our contributors and maintainers. It is because of you that we can bring great software to the community.

Please join us during our online community meetings. Details can be found on our [Carvel website](https://carvel.dev/community/).

You can chat with us on Kubernetes Slack in the #carvel channel and follow us on Twitter at @carvel_dev.

Check out which organizations are using and contributing to Carvel: [Adopter's list](https://github.com/carvel-dev/carvel/blob/master/ADOPTERS.md)