| repository | Repository clone URL.
For example, https://github.com/cloudbees-io/checkout.
| — | ${{ cloudbees.scm.repositoryUrl }} |
| 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, uses the default branch.
| — | — |
| cloudbees-api-token | The CloudBees API Token to use for fetching SCM tokens unless `token` or `ssh-key` have been configured
| — | ${{ cloudbees.api.token }} |
| cloudbees-api-url | The CloudBees API root URL to use for fetching SCM tokens | — | ${{ cloudbees.api.url }} |
| 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.
| — | — |
| 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 keys for github.com, bitbucket.org and gitlab.com are 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 $CLOUDBEES_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 for all branches and tags. | — | 1 |
| lfs | Whether to download Git-LFS files | — | false |
| submodules | Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules.
When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are converted to HTTPS.
| — | false |
| set-safe-directory | Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>` | — | true |