2019-07-23 17:50:59 +02:00
name : 'Checkout'
2019-12-05 05:43:03 +01:00
description : 'Checkout a Git repository at a particular version'
2019-07-23 17:50:59 +02:00
inputs :
repository :
2019-12-03 22:47:19 +01:00
description : 'Repository name with owner. For example, actions/checkout'
2019-12-03 16:28:59 +01:00
default : ${{ github.repository }}
2019-07-23 17:50:59 +02:00
ref :
2019-12-03 16:28:59 +01:00
description : >
2019-12-12 19:49:26 +01: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
event. Otherwise, defaults to `master`.
2019-07-23 17:50:59 +02:00
token :
2019-12-12 19:49:26 +01:00
description : >
Auth token used to fetch the repository. The token is stored in the local
git config, which enables your scripts to run authenticated git commands.
2020-01-03 18:32:17 +01:00
The post-job step removes the token from the git config. [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 16:28:59 +01:00
default : ${{ github.token }}
2019-12-12 19:49:26 +01:00
persist-credentials :
description : 'Whether to persist the token in the git config'
default : true
2019-12-03 16:28:59 +01:00
path :
description : 'Relative path under $GITHUB_WORKSPACE to place the repository'
2019-07-23 17:50:59 +02:00
clean :
2019-12-03 16:28:59 +01:00
description : 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
2019-07-23 17:50:59 +02:00
default : true
fetch-depth :
2019-12-03 16:28:59 +01:00
description : 'Number of commits to fetch. 0 indicates all history.'
default : 1
lfs :
description : 'Whether to download Git-LFS files'
default : false
2020-03-05 20:21:59 +01:00
submodules :
description : >
Whether to checkout submodules : `true` to checkout submodules or `recursive` to
recursively checkout submodules.
default : false
2019-07-23 17:50:59 +02:00
runs :
2019-12-03 16:28:59 +01:00
using : node12
main : dist/index.js
2019-12-05 05:43:03 +01:00
post : dist/index.js