From 1d1b6af9f4bcc104ee99211717fbebb2a7895edc Mon Sep 17 00:00:00 2001 From: Evan Stoddard Date: Thu, 27 Aug 2020 10:00:31 -0500 Subject: [PATCH] docs: clarify git plugin credential usage on protected branches --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f043f47..0e9251e 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ steps: ``` **IMPORTANT**: `GITHUB_TOKEN` does not have the required permissions to operate on protected branches. -If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). +If you are using this action for protected branches, replace `GITHUB_TOKEN` with [Personal Access Token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). If using the `@semantic-release/git` plugin for protected branches, avoid persisting credentials as part of `actions/checkout@v2` by setting the parameter `persist-credentials: false`. This credential does not have the required permission to operate on protected branches. ### Inputs | Input Parameter | Required | Description |