https://github.com/bolteu/checkout-sparse
This action is a wrapper for `git sparse-checkout` command
https://github.com/bolteu/checkout-sparse
actions git sparse-checkout
Last synced: about 2 months ago
JSON representation
This action is a wrapper for `git sparse-checkout` command
- Host: GitHub
- URL: https://github.com/bolteu/checkout-sparse
- Owner: bolteu
- Created: 2021-11-15T10:58:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-05-06T12:14:07.000Z (about 2 months ago)
- Last Synced: 2026-05-06T13:39:10.456Z (about 2 months ago)
- Topics: actions, git, sparse-checkout
- Homepage:
- Size: 305 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# checkout-sparse action
> [!WARNING]
> This action is deprecated.
>
> Please migrate to the official `actions/checkout` action, which supports sparse checkout natively.
>
> ```yml
> - uses: actions/checkout@v6
> with:
> ref: dev
> sparse-checkout: |
> dir-A/
> dir-B/
> file-A
> file-B
> sparse-checkout-cone-mode: true
> ```
This action is a compatibility wrapper for `actions/checkout` sparse checkout support.
It keeps the existing `checkout-sparse` inputs for migration purposes while delegating checkout behavior to the official `actions/checkout` action.
## Inputs
## `ref`
**Required** The git ref. Could be either branch name or git tag. Default `"dev"`.
Examples of supported `ref`s:
- `dev`
- `refs/heads/dev`
- `v1.2.3`
- `refs/tags/v1.2.3`
## `files`
**Required** The list of files/directories to checkout separated by `space`. Default `""`.
## `github-token`
The GitHub personal access token. Default is `secrets.GITHUB_TOKEN`.
## Example usage
```yml
uses: bolteu/checkout-sparse@main
with:
ref: dev
files: dir-A/ dir-B/ file-A file-B
github-token: $GITHUB_TOKEN
```