verily-src/Checkout
Checkout a Git repository at a particular version
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| repository | Repository name without owner, 'verily-src'. For example, actions/checkout | — | — |
| ref | 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 | 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. We recommend using a service account with the least permissions necessary. 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) | — | ${{ github.token }} |
| ssh-key | SSH key used to fetch the repository. The SSH key is configured with the local git config, which enables your scripts to run authenticated git commands. The post-job step removes the SSH key. We recommend using a service account with the least permissions 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) | — | — |
| ssh-known-hosts | 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 | 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. | — | true |
| persist-credentials | Whether to configure the token or SSH key with the local git config | — | true |
| path | Relative path under $GITHUB_WORKSPACE to place the repository | — | — |
| clean | Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching | — | true |
| fetch-depth | Number of commits to fetch. 0 indicates all history. | — | 1 |
| lfs | Whether to download Git-LFS files | — | false |
Outputs
no outputs