From 8eb06e75545deb31e9bd5c8653c93b9d69fe44dd Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Tue, 16 Jan 2024 12:56:59 -0800 Subject: [PATCH] docs: Add permission condition to docs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index db9cd4f6..7981fdf8 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,15 @@ permissions: pull-requests: write ``` +If your repository is private, setting this setting removes all default permissions on your workflow, so for the actions/checkout step to work which is highly common, you will also need the `contents` permissions set. +Otherwise you will get an error such as "fatal: repository *** not found" + +```yaml +permissions: + pull-requests: write + contents: read +``` + For more detailed information about permissions, you can read from the link below: