description:'Checkout a Git repository at a particular version'
inputs:
repository:
description:'Repository name with owner. For example, actions/checkout'
default:${{ github.repository }}
ref:
description:>
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:
description:>
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)
default:${{ github.token }}
ssh-key:
description:>
SSH key used to fetch the repository. The SSH key is configured with the local
git config, which enables your scripts to run authenticated git commands.
The post-job step removes the SSH key.
We recommend using a service account with the least permissions necessary.
Known hosts in addition to the user and global host key database. The public
SSH keys for a host may be obtained using the utility `ssh-keyscan`. For example,
`ssh-keyscan github.com`. The public key for github.com is always implicitly added.
ssh-strict:
description:>
Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes`
and `CheckHostIP=no` to the SSH command line. Use the input `ssh-known-hosts` to
configure additional hosts.
default:true
persist-credentials:
description:'Whether to configure the token or SSH key with the local git config'
default:true
path:
description:'Relative path under $GITHUB_WORKSPACE to place the repository'
clean:
description:'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
default:true
filter:
description:>
Partially clone against a given filter.
Overrides sparse-checkout if set.
default:null
sparse-checkout:
description:>
Do a sparse checkout on given patterns.
Each pattern should be separated with new lines.
default:null
sparse-checkout-cone-mode:
description:>
Specifies whether to use cone-mode when doing a sparse checkout.
default:true
fetch-depth:
description:'Number of commits to fetch. 0 indicates all history for all branches and tags.'
default:1
fetch-tags:
description:'Whether to fetch tags, even if fetch-depth > 0.'
default:false
show-progress:
description:'Whether to show progress status output when fetching.'
default:true
lfs:
description:'Whether to download Git-LFS files'
default:false
submodules:
description:>
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.
default:false
submodulesFetchJobs:
description:>
Specifies how many submodules are fetched/cloned at the same time. A positive integer allows up to that number of submodules fetched in parallel. A value of 0 will give some reasonable default. If unset, it defaults to 1.
default:1
set-safe-directory:
description:Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`
default:true
github-server-url:
description:The base URL for the GitHub instance that you are trying to clone from, will use environment defaults to fetch from the same instance that the workflow is running from unless specified. Example URLs are https://github.com or https://my-ghes-server.example.com
