https://github.com/carvel-dev/setup-action
Github Action for setting up Carvel apps (ytt, kbld, kapp, kctrl, kwt, imgpkg and vendir)
https://github.com/carvel-dev/setup-action
carvel
Last synced: about 1 month ago
JSON representation
Github Action for setting up Carvel apps (ytt, kbld, kapp, kctrl, kwt, imgpkg and vendir)
- Host: GitHub
- URL: https://github.com/carvel-dev/setup-action
- Owner: carvel-dev
- License: apache-2.0
- Created: 2020-02-22T18:42:22.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-08-06T06:16:50.000Z (2 months ago)
- Last Synced: 2025-09-05T18:37:20.057Z (about 1 month ago)
- Topics: carvel
- Language: TypeScript
- Homepage:
- Size: 3.68 MB
- Stars: 16
- Watchers: 12
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
# carvel-setup-action
[](https://github.com/carvel-dev/setup-action/actions?query=branch%3Adevelop+workflow%3Abuild)
[](https://github.com/carvel-dev/setup-action/actions?query=workflow%3Arelease)
A [Github Action](https://github.com/features/actions) to install [Carvel apps](https://carvel.dev/) (ytt, kbld, kapp, kwt, imgpkg, vendir and kctrl).
- Slack: [#carvel in Kubernetes slack](https://slack.kubernetes.io)
## Usage
By default, installs latest versions of `ytt`, `kbld`, `kapp`, `kwt`, `imgpkg`, `vendir` and `kctrl`:
```yaml
steps:
- uses: carvel-dev/setup-action@v2
- run: |
ytt version
kbld version
```
`carvel-setup-action` uses the GitHub API to find information about latest releases. To avoid [rate limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting) it is recommended you pass a [token](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token):
```yaml
steps:
- uses: carvel-dev/setup-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
- run: |
ytt version
kbld version
```
To install only specific apps:
```yaml
steps:
- uses: carvel-dev/setup-action@v2
with:
only: ytt, kbld
- run: |
ytt version
kbld version
```
To exclude specific apps:
```yaml
steps:
- uses: carvel-dev/setup-action@v2
with:
exclude: kwt, vendir
- run: |
ytt version
kbld version
```
To use a specific version of an app:
```yaml
steps:
- uses: carvel-dev/setup-action@v2
with:
only: ytt, kbld
kbld: v0.28.0
- run: |
ytt version
kbld version
```
## Node version support
Version `v2` requires a Node 20 runner. If you're using older self-hosted runners, you can still use `v1` for Node 16 support.
## Development
See [DEVELOPMENT](https://github.com/carvel-dev/setup-action/blob/develop/DEVELOPMENT.md).