1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-11-22 06:36:25 +00:00
checkout/action.yml

42 lines
1.7 KiB
YAML
Raw Normal View History

name: 'Checkout'
2019-12-05 04:43:03 +00:00
description: 'Checkout a Git repository at a particular version'
inputs:
repository:
2019-12-03 21:47:19 +00:00
description: 'Repository name with owner. For example, actions/checkout'
default: ${{ github.repository }}
ref:
description: >
2019-12-12 18:49:26 +00: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`.
token:
2019-12-12 18:49:26 +00: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.
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)
default: ${{ github.token }}
2019-12-12 18:49:26 +00:00
persist-credentials:
description: 'Whether to persist the token in the 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
fetch-depth:
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 19:21:59 +00:00
submodules:
description: >
Whether to checkout submodules: `true` to checkout submodules or `recursive` to
recursively checkout submodules.
default: false
runs:
using: node12
main: dist/index.js
2019-12-05 04:43:03 +00:00
post: dist/index.js