From 02f48b155bab76545d98f3b5d44b53b67297d39a Mon Sep 17 00:00:00 2001
From: Julia March <101819212+juliamrch@users.noreply.github.com>
Date: Mon, 29 Jul 2024 18:20:07 +0200
Subject: [PATCH] doc: include GITHUB_TOKEN in mandatory config

---
 README.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index eb023a4..3b63f21 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,8 @@ The action will consider both branches on the same repository, and pull requests
 Add the following secrets to your repository, in **Settings > Secrets and variables**:
 
 - `CLEVER_SECRET` and `CLEVER_TOKEN`: find them in your `clever-tools.json` after installing the CLI (example path on Mac: `~/.config/clever-cloud/clever-tools.json`)
-- `ORGA_ID`: the organisation in which your app is created
+- `ORGA_ID`: the organisation in which your app is create
+- `GITHUB_TOKEN`: implicit, to enable comments on the PR
 
 For better security, we advise generating a specific `CLEVER_SECRET` and `CLEVER_TOKEN` for GitHub Actions. Follow these steps to do so:
 
@@ -84,6 +85,7 @@ To inject your app secrets and environment variables on Clever Cloud, add them t
 name: Create review app
         uses: CleverCloud/clever-cloud-review-app@latest
         env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # To enable comments on the PR
           CLEVER_SECRET: ${{ secrets.CLEVER_SECRET }}
           CLEVER_TOKEN: ${{ secrets.CLEVER_TOKEN }}
           ORGA_ID: ${{ secrets.ORGA_ID }}