From db059ed1f135278f86ed9852343c491dfbdb7f63 Mon Sep 17 00:00:00 2001
From: Dundar Goc <gocdundar@gmail.com>
Date: Tue, 24 May 2022 12:29:12 +0200
Subject: [PATCH] ci(api-docs): add comment explaining why full clone is
 required

---
 .github/workflows/api-docs.yml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
index 167d799c27..8757c4e52c 100644
--- a/.github/workflows/api-docs.yml
+++ b/.github/workflows/api-docs.yml
@@ -30,6 +30,9 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
+          # Fetch depth 0 is required if called through workflow_call. In order
+          # to create a PR we need to access other branches, which requires a
+          # full clone.
           fetch-depth: 0
 
       - name: Install dependencies