2022-03-14 18:53:58 +08:00
name: - name : Checkout
uses : actions/checkout@v3.0.0
2019-12-05 12:43:03 +08:00
description : 'Checkout a Git repository at a particular version'
2020-03-12 03:55:17 +08:00
inputs :
2019-07-23 23:50:59 +08:00
repository :
2019-12-04 05:47:19 +08:00
description : 'Repository name with owner. For example, actions/checkout'
2019-12-03 23:28:59 +08:00
default : ${{ github.repository }}
2019-07-23 23:50:59 +08:00
ref :
2019-12-03 23:28:59 +08:00
description : >
2019-12-13 02:49:26 +08: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-17 01:41:01 +08:00
event. Otherwise, uses the default branch.
2019-07-23 23:50:59 +08:00
token :
2019-12-13 02:49:26 +08:00
description : >
2020-03-12 03:55:17 +08: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 23:42:38 +08:00
We recommend using a service account with the least permissions necessary.
2020-03-12 03:55:17 +08: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 23:28:59 +08:00
default : ${{ github.token }}
2020-03-12 03:55:17 +08:00
ssh-key :
description : >
2020-03-12 23:42:38 +08:00
SSH key used to fetch the repository. The SSH key is configured with the local
2020-03-12 03:55:17 +08:00
git config, which enables your scripts to run authenticated git commands.
The post-job step removes the SSH key.
2020-03-12 23:42:38 +08:00
We recommend using a service account with the least permissions necessary.
2020-03-12 03:55:17 +08: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
2019-12-13 02:49:26 +08:00
persist-credentials :
2020-03-12 03:55:17 +08:00
description : 'Whether to configure the token or SSH key with the local git config'
2019-12-13 02:49:26 +08:00
default : true
2019-12-03 23:28:59 +08:00
path :
description : 'Relative path under $GITHUB_WORKSPACE to place the repository'
2019-07-23 23:50:59 +08:00
clean :
2019-12-03 23:28:59 +08:00
description : 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
2019-07-23 23:50:59 +08:00
default : true
fetch-depth :
2020-07-13 09:02:24 +08:00
description : 'Number of commits to fetch. 0 indicates all history for all branches and tags.'
2019-12-03 23:28:59 +08:00
default : 1
lfs :
description : 'Whether to download Git-LFS files'
default : false
2020-03-06 03:21:59 +08:00
submodules :
description : >
Whether to checkout submodules : `true` to checkout submodules or `recursive` to
recursively checkout submodules.
2020-03-12 03:55:17 +08:00
When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are
converted to HTTPS.
2020-03-06 03:21:59 +08:00
default : false
2019-07-23 23:50:59 +08:00
runs :
2022-03-01 05:17:29 +08:00
using : node16
2019-12-03 23:28:59 +08:00
main : dist/index.js
2019-12-05 12:43:03 +08:00
post : dist/index.js