Browse Source

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

pull/11976/head
Sebastián Ramírez 8 months ago
committed by GitHub
parent
commit
233bab7f41
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 2
      .github/workflows/deploy-docs.yml
  2. 14
      scripts/deploy_docs_status.py

2
.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"

14
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,
)

Loading…
Cancel
Save