Merge pull request #1223 from BenjaminMichaelis/patch-1

docs: Add permission condition to docs
marocchino · Jan 17, 2024 · bb0b1bb · bb0b1bb
2 parents ab84503 + 8eb06e7
commit bb0b1bb
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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:
 <https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs>