👷 Update docs-previews to handle no docs changes (#1056)

diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
index 619e689dcb60cc4df70b4e1729c1de2aa9162f5f..ca433106911650fd02acc13e129cd44842c07a9d 100644 (file)
--- a/.github/workflows/deploy-docs.yml
+++ b/.github/workflows/deploy-docs.yml
@@ -64,10 +64,10 @@ jobs:
           gitHubToken: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ ( github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.head_branch == 'main' && 'main' ) || ( github.event.workflow_run.head_sha ) }}
       - name: Comment Deploy
-        if: steps.deploy.outputs.url != ''
         run: python ./scripts/deploy_docs_status.py
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DEPLOY_URL: ${{ steps.deploy.outputs.url }}
           COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
           RUN_ID: ${{ github.run_id }}
+          IS_DONE: "true"

diff --git a/scripts/deploy_docs_status.py b/scripts/deploy_docs_status.py
index e4e665e86561b18a5e5e888947810bb61bc90d91..8cef2f75814fd4ca50a6ec9de0358b8580bb2d0f 100644 (file)
--- a/scripts/deploy_docs_status.py
+++ b/scripts/deploy_docs_status.py
@@ -12,6 +12,7 @@ class Settings(BaseSettings):
     deploy_url: str | None = None
     commit_sha: str
     run_id: int
+    is_done: bool = False
 
 
 def main():
@@ -30,10 +31,19 @@ def main():
     commits = list(use_pr.get_commits())
     current_commit = [c for c in commits if c.sha == settings.commit_sha][0]
     run_url = f"https://github.com/{settings.github_repository}/actions/runs/{settings.run_id}"
+    if settings.is_done and not settings.deploy_url:
+        current_commit.create_status(
+            state="success",
+            description="No Docs Changes",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No docs changes found")
+        return
     if not settings.deploy_url:
         current_commit.create_status(
             state="pending",
-            description="Deploy Docs",
+            description="Deploying Docs",
             context="deploy-docs",
             target_url=run_url,
         )
@@ -41,7 +51,7 @@ def main():
         return
     current_commit.create_status(
         state="success",
-        description="Deploy Docs",
+        description="Docs Deployed",
         context="deploy-docs",
         target_url=run_url,
     )