From 3c0804ea1652c0cdfd3eb1a1bd93b22a0a72616d Mon Sep 17 00:00:00 2001
From: Mentor Palokaj <mentor@palokaj.co>
Date: Mon, 2 Sep 2024 11:39:36 +0200
Subject: [PATCH] Add permission documentation for GITHUB_TOKEN

When following the docs verbatim, Github Actions fail with a `403` error since the default setting of the `GITHUB_TOKEN` is read-only.
---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index c755c43..3c9b30f 100644
--- a/README.md
+++ b/README.md
@@ -104,6 +104,8 @@ this secret yourself - GitHub sets it automatically.
 If you omit this option, you'll need to find the preview URL in the action's
 build log.
 
+For this to work your `GITHUB_TOKEN` permissions must be set to "Read and write permissions". This is set in your repository settings under `Actions > General > Workflow permissions`.
+
 ### `expires` _{string}_
 
 The length of time the preview channel should remain active after the last deploy.