From 1507b4496a186aa61bd169e3ce88a6176c94cceb Mon Sep 17 00:00:00 2001
From: Adi Roiban <adiroiban@gmail.com>
Date: Sun, 8 Aug 2021 11:02:44 +0100
Subject: [PATCH] Document gh-pages updates

---
 .github/workflows/tests.yaml | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
index 66c9f64..76027af 100644
--- a/.github/workflows/tests.yaml
+++ b/.github/workflows/tests.yaml
@@ -4,6 +4,10 @@ name: CI
 
 on:
   push:
+    # Make sure to not enable `push` events for other branches as this will
+    # trigger the publishing to gh-pages from any branch.
+    # If you need to enable more branches look below and update
+    # the conditions for which gh-pages are updated.
     branches: [ trunk ]
     tags:
       - incremental-*
@@ -64,8 +68,8 @@ jobs:
         mv apidocs website/docs
 
     - name: Publish documentation for push on trunk
-      # FIXME:
-      # Add push event condition before merge.
+      # Since we don't have a separate job for apidocs gh-pages updating
+      # hijack the normal apidoc test and publish the resulting files. 
       if: contains(matrix['tox-env'], 'apidocs') && github.event_name == 'push'
       uses: peaceiris/actions-gh-pages@v3
       with: