2019-07-23 11:50:59 -04:00
name : 'Checkout'
2019-12-04 23:43:03 -05:00
description : 'Checkout a Git repository at a particular version'
2020-03-11 15:55:17 -04:00
inputs :
2019-07-23 11:50:59 -04:00
repository :
2019-12-03 16:47:19 -05:00
description : 'Repository name with owner. For example, actions/checkout'
2019-12-03 10:28:59 -05:00
default : ${{ github.repository }}
2019-07-23 11:50:59 -04:00
ref :
2019-12-03 10:28:59 -05:00
description : >
2019-12-12 13:49:26 -05:00
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
2020-06-16 13:41:01 -04:00
event. Otherwise, uses the default branch.
2019-07-23 11:50:59 -04:00
token :
2019-12-12 13:49:26 -05:00
description : >
2020-03-11 15:55:17 -04:00
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.
2020-03-12 11:42:38 -04:00
We recommend using a service account with the least permissions necessary.
2020-03-11 15:55:17 -04:00
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)
2019-12-03 10:28:59 -05:00
default : ${{ github.token }}
2020-03-11 15:55:17 -04:00
ssh-key :
description : >
2020-03-12 11:42:38 -04:00
SSH key used to fetch the repository. The SSH key is configured with the local
2020-03-11 15:55:17 -04:00
git config, which enables your scripts to run authenticated git commands.
The post-job step removes the SSH key.
2020-03-12 11:42:38 -04:00
We recommend using a service account with the least permissions necessary.
2020-03-11 15:55:17 -04:00
[ 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)
ssh-known-hosts :
description : >
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
2024-04-18 15:29:55 -04:00
ssh-user :
description : >
The user to use when connecting to the remote SSH host. By default 'git' is used.
default : git
2019-12-12 13:49:26 -05:00
persist-credentials :
2020-03-11 15:55:17 -04:00
description : 'Whether to configure the token or SSH key with the local git config'
2019-12-12 13:49:26 -05:00
default : true
2019-12-03 10:28:59 -05:00
path :
description : 'Relative path under $GITHUB_WORKSPACE to place the repository'
2019-07-23 11:50:59 -04:00
clean :
2019-12-03 10:28:59 -05:00
description : 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
2019-07-23 11:50:59 -04:00
default : true
2023-09-22 13:30:36 -04:00
filter :
description : >
Partially clone against a given filter.
Overrides sparse-checkout if set.
default : null
2023-06-09 09:08:21 -04:00
sparse-checkout :
description : >
Do a sparse checkout on given patterns.
2023-09-22 13:30:36 -04:00
Each pattern should be separated with new lines.
2023-06-09 09:08:21 -04:00
default : null
sparse-checkout-cone-mode :
description : >
Specifies whether to use cone-mode when doing a sparse checkout.
default : true
2019-07-23 11:50:59 -04:00
fetch-depth :
2020-07-12 21:02:24 -04:00
description : 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
2019-12-03 10:28:59 -05:00
default : 1
2023-08-16 16:34:54 -04:00
fetch-tags :
description : 'Whether to fetch tags, even if fetch-depth > 0.'
default : false
2023-09-01 14:19:18 -04:00
show-progress :
description : 'Whether to show progress status output when fetching.'
default : true
2019-12-03 10:28:59 -05:00
lfs :
description : 'Whether to download Git-LFS files'
default : false
2020-03-05 14:21:59 -05:00
submodules :
description : >
Whether to checkout submodules : `true` to checkout submodules or `recursive` to
recursively checkout submodules.
2020-03-11 15:55:17 -04:00
When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are
converted to HTTPS.
2020-03-05 14:21:59 -05:00
default : false
2022-04-20 21:37:43 -04:00
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
2022-09-26 12:34:52 -04:00
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
required : false
2023-09-19 12:30:16 -04:00
working-directory :
description : Provide the working directory for the git commands to execute into, defaults to $GITHUB_WORKSPACE
required : false
2019-07-23 11:50:59 -04:00
runs :
2023-08-29 11:01:52 -04:00
using : node20
2019-12-03 10:28:59 -05:00
main : dist/index.js
2019-12-04 23:43:03 -05:00
post : dist/index.js