@ -8,7 +8,7 @@ This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workfl
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth: 0` to fetch all history for all branches and tags. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth: 0` to fetch all history for all branches and tags. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: false` to opt-out.
The auth token can be persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set `persist-credentials: true` to opt-in.
When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.
When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.
@ -66,7 +66,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
ssh-strict: ''
ssh-strict: ''
# Whether to configure the token or SSH key with the local git config
# Whether to configure the token or SSH key with the local git config
# Default: true
# Default: false
persist-credentials: ''
persist-credentials: ''
# Relative path under $GITHUB_WORKSPACE to place the repository
# Relative path under $GITHUB_WORKSPACE to place the repository
@ -108,15 +108,20 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl
# Scenarios
# Scenarios
- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
- [Checkout V3](#checkout-v3)
- [Checkout a different branch](#Checkout-a-different-branch)
- [What's new](#whats-new)
- [Checkout HEAD^](#Checkout-HEAD)
- [Usage](#usage)
- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)