Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ By default, installs latest versions of `ytt`, `kbld`, `kapp`, `kwt`, `imgpkg`,

```yaml
steps:
- uses: carvel-dev/setup-action@v2
- uses: carvel-dev/setup-action@v3
- run: |
ytt version
kbld version
Expand All @@ -23,7 +23,7 @@ steps:

```yaml
steps:
- uses: carvel-dev/setup-action@v2
- uses: carvel-dev/setup-action@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
- run: |
Expand All @@ -35,7 +35,7 @@ To install only specific apps:

```yaml
steps:
- uses: carvel-dev/setup-action@v2
- uses: carvel-dev/setup-action@v3
with:
only: ytt, kbld
- run: |
Expand All @@ -47,7 +47,7 @@ To exclude specific apps:

```yaml
steps:
- uses: carvel-dev/setup-action@v2
- uses: carvel-dev/setup-action@v3
with:
exclude: kwt, vendir
- run: |
Expand All @@ -59,7 +59,7 @@ To use a specific version of an app:

```yaml
steps:
- uses: carvel-dev/setup-action@v2
- uses: carvel-dev/setup-action@v3
with:
only: ytt, kbld
kbld: v0.28.0
Expand All @@ -68,6 +68,33 @@ steps:
kbld version
```

When you host the carvel repositories in your own github instance:

```yaml
steps:
- uses: carvel-dev/setup-action@v3
with:
endpoint: https://acme.github.com/api/v3
token: token-for-your-instance
- run: |
ytt version
kbld version
```

When you are running the action in your own github instance and want to retrieve carvel from the github.com:

```yaml
steps:
- uses: carvel-dev/setup-action@v3
with:
token: TOKEN-FROM-GITHUB.COM
- run: |
ytt version
kbld version
```



## Node version support

Version `v3` requires a Node 24 runner. If you're using older self-hosted runners, you can still use `v2` for Node 20 support or `v1` for Node 16 support.
Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ inputs:
description: Github token to use to avoid rate limits
required: false
default: ""
endpoint:
description: Defines the API base URL to use instead of the default GitHub API. This must be an API URL compatible with Octokit `baseUrl` (for example, `https://HOST/api/v3` for GitHub Enterprise Server), not the GitHub web UI URL.
required: false
default: "https://api.github.com"
only:
description: List apps to download if you don't need all
required: false
Expand Down
Loading
Loading