Merge branch 'master' into test-redistribute

fastapi · Aug 8, 2024 · 63d9476 · 63d9476
2 parents d823424 + 72b8a76
commit 63d9476
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git 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 == 'master' && '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/docs/release-notes.md b/docs/release-notes.md
@@ -6,6 +6,7 @@
 
 ### Internal
 
+* 👷 Update docs-previews to handle no docs changes. PR [#912](https://github.com/tiangolo/typer/pull/912) by [@tiangolo](https://github.com/tiangolo).
 * 👷🏻 Show docs deployment status and preview URLs in comment. PR [#910](https://github.com/tiangolo/typer/pull/910) by [@tiangolo](https://github.com/tiangolo).
 * 🔧 Enable auto dark mode from system. PR [#908](https://github.com/tiangolo/typer/pull/908) by [@tiangolo](https://github.com/tiangolo).
 * 💄 Add dark mode logo. PR [#907](https://github.com/tiangolo/typer/pull/907) by [@tiangolo](https://github.com/tiangolo).

diff --git 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,18 +31,27 @@ 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,
         )
         logging.info("No deploy URL available yet")
         return
     current_commit.create_status(
         state="success",
-        description="Deploy Docs",
+        description="Docs Deployed",
         context="deploy-docs",
         target_url=run_url,
     )