From a8ee10b16b9ed68c26b80d4b54c9a6b2806a8c8c Mon Sep 17 00:00:00 2001 From: eric sciple Date: Thu, 2 Jan 2020 13:23:30 -0500 Subject: [PATCH 1/4] improve summary --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 99b9c1fca..20bc6d8e5 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,28 @@ # Checkout V2 -This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. +This action checks-out your repository under `$GITHUB_WORKSPACE`. -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, for the ref/SHA that triggered the workflow. Use the input `fetch-depth` for more control. 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. Use the input `persist-credentials` 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 + - Note, when using a job container the action now runs in your container and not on the host - Removed input `submodules` Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous versions. From e95bfc94d04f864386d221f2138ab53ebb291370 Mon Sep 17 00:00:00 2001 From: eric sciple Date: Thu, 2 Jan 2020 13:30:36 -0500 Subject: [PATCH 2/4] . --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20bc6d8e5..56179872a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This action checks-out your repository under `$GITHUB_WORKSPACE`. -Only a single commit is fetched, for the ref/SHA that triggered the workflow. Use the input `fetch-depth` for more control. 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` 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. 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. Use the input `persist-credentials` to opt-out. @@ -25,7 +25,7 @@ When Git 2.18 or higher is not in your PATH, falls back to the REST API to downl - 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 - - Note, when using a job container the action now runs in your container and not on the host + - 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. From 3c73ba77aae9b6941940de220c85f8049290cc02 Mon Sep 17 00:00:00 2001 From: eric sciple Date: Thu, 2 Jan 2020 13:33:18 -0500 Subject: [PATCH 3/4] . --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56179872a..9f0834013 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ # Checkout V2 -This action checks-out your repository under `$GITHUB_WORKSPACE`. +This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it. 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. From ee06039bc17acfe554bb258bd50022e4802e3bfc Mon Sep 17 00:00:00 2001 From: eric sciple Date: Thu, 2 Jan 2020 14:09:10 -0500 Subject: [PATCH 4/4] . --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f0834013..4abc07b7f 100644 --- a/README.md +++ b/README.md @@ -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` 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. -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. Use the input `persist-credentials` to opt-out. +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.