mirror of
https://github.com/actions/checkout.git
synced 2024-11-27 00:26:20 +01:00
36 lines
1.5 KiB
YAML
36 lines
1.5 KiB
YAML
name: 'Checkout'
|
|
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, defaults to `master`.
|
|
token:
|
|
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 }}
|
|
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
|
|
runs:
|
|
using: node12
|
|
main: dist/index.js
|
|
post: dist/index.js
|