namespacelabs/Checkout Action
Checkout a Git repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| repository | Repository name with owner. For example, namespacelabs/foundation | — | ${{ github.repository }} |
| ref | The branch, tag or SHA to checkout. When checking out the repository that triggered a workflow, this defaults to the reference or SHA for that event. Otherwise, uses the default branch. | — | — |
| token | Personal access token (PAT) used to fetch the repository. The PAT is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the PAT. We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | — | ${{ github.token }} |
| fetch-depth | Number of commits to fetch. 0 indicates all history for all branches and tags. | — | 1 |
| persist-credentials | Whether to configure the token or SSH key with the local git config | — | true |
| path | Relative path under $GITHUB_WORKSPACE to place the repository | — | — |
| submodules | Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules. When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are converted to HTTPS. | — | false |
| dissociate | Whether to dissociate the checkout (and submodules, if any) from the Namespace Git mirror: `true` to dissociate the main checkout, `recursive` to dissociate the main checkout and all submodules. | — | false |
| lfs | Whether to download and cache Git-LFS files | — | false |
| lfs-mode | Controls how LFS objects are pre-fetched into the cached Git mirror. Only takes effect when `lfs: true`. - `default`: pre-fetch LFS for every ref the mirror's git fetch just updated. Best across-ref cache reuse on warm mirrors, but on a cold cache this downloads the entire repository's LFS history across all branches and tags, which can be slow. - `ref`: pre-fetch LFS only for the ref being checked out. - `recent`: pre-fetch LFS for refs updated in the last `lfs.fetchrecentrefsdays` (default 7) days. - `skip-cache`: LFS objects are downloaded fresh from the remote instead of being cached. This is used to debug performance issues and should not be used in production. | — | default |
| filter | Partially clone against a given filter. | — | "" |
| sparse-checkout | Do a sparse checkout on given patterns. Each pattern should be separated with new lines. | — | "" |
| sparse-checkout-cone-mode | Specifies whether to use cone-mode when doing a sparse checkout. | — | true |
| max-attempts | Maximum number of attempts for git network operations. Set to 1 to disable retries. | — | 3 |
| trace | Enable git tracing (GIT_TRACE) for debugging. | — | false |
| cancel-stalling-git-operations | Abort git HTTP transfers that stall (below ~1 KB/s for 60s), so the inbuilt retry logic kicks in. | — | true |
Outputs
no outputs