diff options
| author | eric sciple <ericsciple@users.noreply.github.com> | 2020-01-02 15:40:10 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-02 15:40:10 -0500 |
| commit | 70ca8ea8edb415caab2746d59ac5ad8245858b1b (patch) | |
| tree | 8b11fd5ad479cad967c7fbf746f993339064feb0 /README.md | |
| parent | b49cea0125b7e9d0bbacb9720c8e874296bcea40 (diff) | |
improve summary (#127)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 8 insertions, 9 deletions
@@ -6,27 +6,26 @@ This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. -By default, the repository that triggered the workflow is checked-out, for the ref/SHA that triggered the event. +Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set `fetch-depth` to fetch more history. Refer [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events. -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. + +When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files. # What's new -- Improved fetch performance - - The default behavior now fetches only the commit being checked-out +- Improved performance + - Fetches only a single commit by default - Script authenticated git commands - - Persists the input `token` in the local git config - - Enables your scripts to run authenticated git commands - - Post-job cleanup removes the token - - Opt out by setting the input `persist-credentials: false` + - Auth token persisted in the local git config - Creates a local branch - No longer detached HEAD when checking out a branch - - A local branch is created with the corresponding upstream branch set - Improved layout - The input `path` is always relative to $GITHUB_WORKSPACE - Aligns better with container actions, where $GITHUB_WORKSPACE gets mapped in - Fallback to REST API download - When Git 2.18 or higher is not in the PATH, the REST API will be used to download the files + - When using a job container, the container's PATH is used - Removed input `submodules` Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions. |