From 42d0d6e4a51273dca8eb2ab58eda8d840c87c6f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= <tiangolo@gmail.com>
Date: Fri, 23 Jun 2023 19:55:09 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=91=B7=20Build=20and=20deploy=20docs=20on?=
 =?UTF-8?q?ly=20on=20docs=20changes=20(#9728)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/workflows/build-docs.yml   | 26 +++++++++++++++++++++++++-
 .github/workflows/preview-docs.yml |  5 +++++
 2 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index a0e83e5c8..fb1fa6f09 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -4,9 +4,33 @@ on:
     branches:
       - master
   pull_request:
-    types: [opened, synchronize]
+    types:
+      - opened
+      - synchronize
 jobs:
+  changes:
+    runs-on: ubuntu-latest
+    # Required permissions
+    permissions:
+      pull-requests: read
+    # Set job outputs to values from filter step
+    outputs:
+      docs: ${{ steps.filter.outputs.docs }}
+    steps:
+    - uses: actions/checkout@v3
+    # For pull requests it's not necessary to checkout the code but for master it is
+    - uses: dorny/paths-filter@v2
+      id: filter
+      with:
+        filters: |
+            docs:
+              - README.md
+              - docs/**
+              - docs_src/**
+              - requirements-docs.txt
   build-docs:
+    needs: changes
+    if: ${{ needs.changes.outputs.docs == 'true' }}
     runs-on: ubuntu-latest
     steps:
       - name: Dump GitHub context
diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/preview-docs.yml
index 298f75b02..da98f5d2b 100644
--- a/.github/workflows/preview-docs.yml
+++ b/.github/workflows/preview-docs.yml
@@ -16,19 +16,23 @@ jobs:
           rm -rf ./site
           mkdir ./site
       - name: Download Artifact Docs
+        id: download
         uses: dawidd6/action-download-artifact@v2.27.0
         with:
+          if_no_artifact_found: ignore
           github_token: ${{ secrets.FASTAPI_PREVIEW_DOCS_DOWNLOAD_ARTIFACTS }}
           workflow: build-docs.yml
           run_id: ${{ github.event.workflow_run.id }}
           name: docs-zip
           path: ./site/
       - name: Unzip docs
+        if: steps.download.outputs.found_artifact == 'true'
         run: |
           cd ./site
           unzip docs.zip
           rm -f docs.zip
       - name: Deploy to Netlify
+        if: steps.download.outputs.found_artifact == 'true'
         id: netlify
         uses: nwtgck/actions-netlify@v2.0.0
         with:
@@ -40,6 +44,7 @@ jobs:
           NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
           NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
       - name: Comment Deploy
+        if: steps.netlify.outputs.deploy-url != ''
         uses: ./.github/actions/comment-docs-preview-in-pr
         with:
           token: ${{ secrets.FASTAPI_PREVIEW_DOCS_COMMENT_DEPLOY }}