From f005947568048fad7be49212292fbc22ea453cac Mon Sep 17 00:00:00 2001 From: Sebb Date: Wed, 5 Oct 2022 15:36:26 +0100 Subject: [PATCH] Default for persist-credentials should be false --- README.md | 27 ++++++++++++++++----------- action.yml | 2 +- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b85967d..78559a0 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: 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. @@ -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: '' # Whether to configure the token or SSH key with the local git config - # Default: true + # Default: false persist-credentials: '' # 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 -- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches) -- [Checkout a different branch](#Checkout-a-different-branch) -- [Checkout HEAD^](#Checkout-HEAD) -- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side) -- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested) -- [Checkout multiple repos (private)](#Checkout-multiple-repos-private) -- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit) -- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event) -- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token) +- [Checkout V3](#checkout-v3) +- [What's new](#whats-new) +- [Usage](#usage) +- [Scenarios](#scenarios) + - [Fetch all history for all tags and branches](#fetch-all-history-for-all-tags-and-branches) + - [Checkout a different branch](#checkout-a-different-branch) + - [Checkout HEAD^](#checkout-head) + - [Checkout multiple repos (side by side)](#checkout-multiple-repos-side-by-side) + - [Checkout multiple repos (nested)](#checkout-multiple-repos-nested) + - [Checkout multiple repos (private)](#checkout-multiple-repos-private) + - [Checkout pull request HEAD commit instead of merge commit](#checkout-pull-request-head-commit-instead-of-merge-commit) + - [Checkout pull request on closed event](#checkout-pull-request-on-closed-event) + - [Push a commit using the built-in token](#push-a-commit-using-the-built-in-token) +- [License](#license) ## Fetch all history for all tags and branches diff --git a/action.yml b/action.yml index cab09eb..171fd75 100644 --- a/action.yml +++ b/action.yml @@ -47,7 +47,7 @@ inputs: default: true persist-credentials: description: 'Whether to configure the token or SSH key with the local git config' - default: true + default: false path: description: 'Relative path under $GITHUB_WORKSPACE to place the repository' clean: