🔥 Cleanup after upgrade for Docs Previews GitHub Action (#2248)

* 🔧 Upload docs artifacts even on push to avoid breaking Preview Docs

* 🔥 Remove replaced GitHub Action get-artifact

* 🔥 Remove GitHub Action Watch Docs Previews, replaced with Preview Docs

* 🔥 Remove commented backup configs in Preview Docs GitHub Action

* 🔥 Remove no longer needed utils scripts

diff --git a/.github/actions/get-artifact/Dockerfile b/.github/actions/get-artifact/Dockerfile
deleted file mode 100644 (file)
index 1fc6a41..0000000
--- a/.github/actions/get-artifact/Dockerfile
+++ /dev/null
@@ -1,7 +0,0 @@
-FROM python:3.7
-
-RUN pip install httpx "pydantic==1.5.1"
-
-COPY ./app /app
-
-CMD ["python", "/app/main.py"]

diff --git a/.github/actions/get-artifact/action.yml b/.github/actions/get-artifact/action.yml
deleted file mode 100644 (file)
index bff398d..0000000
--- a/.github/actions/get-artifact/action.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-name: "Get Artifact"
-description: "Get artifact, possibly uploaded by a PR, useful to deploy docs previews"
-author: "Sebastián Ramírez <tiangolo@gmail.com>"
-inputs:
-  token:
-    description: 'Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}'
-    required: true
-  name:
-    description: 'Artifact name'
-    required: true
-  path:
-    description: 'Where to store the artifact'
-    required: true
-runs:
-  using: 'docker'
-  image: 'Dockerfile'

diff --git a/.github/actions/get-artifact/app/main.py b/.github/actions/get-artifact/app/main.py
deleted file mode 100644 (file)
index 2ae1ad9..0000000
--- a/.github/actions/get-artifact/app/main.py
+++ /dev/null
@@ -1,63 +0,0 @@
-import logging
-from datetime import datetime
-from pathlib import Path
-from typing import List, Optional
-
-import httpx
-from pydantic import BaseModel, BaseSettings, SecretStr
-
-github_api = "https://api.github.com"
-netlify_api = "https://api.netlify.com"
-
-
-class Settings(BaseSettings):
-    input_name: str
-    input_token: SecretStr
-    input_path: str
-    github_repository: str
-    github_event_path: Path
-    github_event_name: Optional[str] = None
-
-
-class Artifact(BaseModel):
-    id: int
-    node_id: str
-    name: str
-    size_in_bytes: int
-    url: str
-    archive_download_url: str
-    expired: bool
-    created_at: datetime
-    updated_at: datetime
-
-
-class ArtifactResponse(BaseModel):
-    total_count: int
-    artifacts: List[Artifact]
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    settings = Settings()
-    logging.info(f"Using config: {settings.json()}")
-    github_headers = {
-        "Authorization": f"token {settings.input_token.get_secret_value()}"
-    }
-    response = httpx.get(
-        f"{github_api}/repos/{settings.github_repository}/actions/artifacts",
-        headers=github_headers,
-    )
-    data = response.json()
-    artifacts_response = ArtifactResponse.parse_obj(data)
-    use_artifact: Optional[Artifact] = None
-    for artifact in artifacts_response.artifacts:
-        if artifact.name == settings.input_name:
-            use_artifact = artifact
-            break
-    assert use_artifact
-    file_response = httpx.get(
-        use_artifact.archive_download_url, headers=github_headers, timeout=30
-    )
-    zip_file = Path(settings.input_path)
-    zip_file.write_bytes(file_response.content)
-    logging.info("Finished")

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index bcb4e373ec334fe7b3b5501d89d7c52132e5ec99..0afcd5d8b1ee0917009cd12edbe3fe08c64588a4 100644 (file)
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -23,10 +23,8 @@ jobs:
       - name: Build Docs
         run: python3.7 ./scripts/docs.py build-all
       - name: Zip docs
-        if: github.event_name == 'pull_request'
         run: bash ./scripts/zip-docs.sh
       - uses: actions/upload-artifact@v2
-        if: github.event_name == 'pull_request'
         with:
           name: docs-zip
           path: ./docs.zip

diff --git a/.github/workflows/preview-docs.yml b/.github/workflows/preview-docs.yml
index 06992ccba7de501a0f86e710ccb4eab87a4338da..8401e98726783eb7f5a938780c0e5962c83a6fed 100644 (file)
--- a/.github/workflows/preview-docs.yml
+++ b/.github/workflows/preview-docs.yml
@@ -5,30 +5,12 @@ on:
       - Build Docs
     types: 
       - completed
-  # workflow_dispatch:
-  #   inputs:
-  #     pr:
-  #       description: Pull Request number
-  #       required: true
-  #     name:
-  #       description: Artifact name for zip file with docs
-  #       required: true
-  #     commit:
-  #       description: Commit SHA hash
-  #       required: true
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      # - uses: ./.github/actions/get-artifact
-      #   with:
-      #     token: ${{ secrets.GITHUB_TOKEN }}
-      #     name: ${{ github.event.inputs.name }}
-      #     path: ./archive.zip
-      # - name: Unzip docs
-      #   run: bash ./scripts/unzip-docs.sh
       - name: Download Artifact Docs
         uses: dawidd6/action-download-artifact@v2.9.0
         with:

diff --git a/.github/workflows/watch-docs-previews.yml b/.github/workflows/watch-docs-previews.yml
deleted file mode 100644 (file)
index fea49cd..0000000
--- a/.github/workflows/watch-docs-previews.yml
+++ /dev/null
@@ -1,13 +0,0 @@
-# name: Watch Docs Previews
-# on:
-#   schedule:
-#     - cron: "0 * * * *"
-
-# jobs:
-#   deploy:
-#     runs-on: ubuntu-18.04
-#     steps:
-#       - uses: actions/checkout@v2
-#       - uses: ./.github/actions/watch-previews
-#         with:
-#           token: ${{ secrets.ACTIONS_TOKEN }}

diff --git a/scripts/docs-comment-deploy.sh b/scripts/docs-comment-deploy.sh
deleted file mode 100644 (file)
index 7bd7745..0000000
--- a/scripts/docs-comment-deploy.sh
+++ /dev/null
@@ -1,14 +0,0 @@
-#! /usr/bin/env bash
-
-set -x
-set -e
-
-PR=${PR:?Variable not set}
-DEPLOY_URL=${DEPLOY_URL:?Variable not set}
-GITHUB_TOKEN=${GITHUB_TOKEN:?Variable not set}
-COMMIT=${COMMIT:?Variable not set}
-
-curl \
-    -H "Authorization: token ${GITHUB_TOKEN}" \
-    https://api.github.com/repos/tiangolo/fastapi/issues/${PR}/comments \
-    -d '{"body": "📝 Docs preview for commit '"${COMMIT} at: ${DEPLOY_URL}"'"}'

diff --git a/scripts/unzip-docs.sh b/scripts/unzip-docs.sh
deleted file mode 100644 (file)
index 8e83741..0000000
--- a/scripts/unzip-docs.sh
+++ /dev/null
@@ -1,13 +0,0 @@
-#! /usr/bin/env bash
-
-set -x
-set -e
-
-if [ -d ./site/ ]; then
-    rm -rf ./site/
-fi
-unzip archive.zip
-# Double zipped by GitHub when downlading the archive
-unzip docs.zip
-rm -rf archive.zip
-rm -rf docs.zip