From acf5911406dd4ea86a545b90a078aab1ba3bdb58 Mon Sep 17 00:00:00 2001
From: rikhuijzer <rikhuijzer@pm.me>
Date: Mon, 12 Jun 2023 21:46:07 +0200
Subject: [PATCH] Document `permissions: contents: write`

---
 .github/workflows/main.yml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 978c58de514974..5f9714ecf6b0e0 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -11,6 +11,12 @@ on:
 
 jobs:
   build-deploy:
+    # This ensures that the `GITHUB_TOKEN` set in this GitHub Action job
+    # has sufficient privileges to write to a secondary branch. On older
+    # repositories, the `GITHUB_TOKEN` used to have lots of privileges,
+    # but this needs to now be set explicitly. After setting this, people
+    # can just fork `mlir-www` and having a working deploy to the
+    # `gh-pages` branch.
     permissions:
       contents: write
     runs-on: ubuntu-22.04