3
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-11-22 03:19:31 +01:00
checkout/action.yml
Edward Thomson f6ce2afa70 Explain submodules option (#48)
Explain that submodules have several settings: `false`, `true` or `recursive`.
2019-10-03 09:13:19 -04:00

23 lines
964 B
YAML

name: 'Checkout'
description: 'Checkout a Git repository.'
inputs:
repository:
description: 'Repository name'
ref:
description: 'Ref to checkout (SHA, branch, tag)'
token:
description: 'Access token for clone repository'
clean:
description: 'If true, execute `execute git clean -ffdx && git reset --hard HEAD` before fetching'
default: true
submodules:
description: 'Whether to include submodules: false to exclude submodules, true to include only one level of submodules, or recursive to recursively clone submodules; defaults to false'
lfs:
description: 'Whether to download Git-LFS files; defaults to false'
fetch-depth:
description: 'The depth of commits to ask Git to fetch; defaults to no limit'
path:
description: 'Optional path to check out source code'
runs:
# Plugins live on the runner and are only available to a certain set of first party actions.
plugin: 'checkout'