From b268c39758f5d04a11fbe4fe3b37d143aa3fca5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Sun, 19 Jul 2020 22:11:28 +0200 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20internal=20GitHub=20action=20?= =?UTF-8?q?to=20deploy=20docs=20previews=20(#1739)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📝 Update release notes * ✨ Add internal GitHub action to pull docs artifact * 🙈 Add archive.zip to gitignore --- .github/actions/get-artifact/Dockerfile | 7 +++ .github/actions/get-artifact/action.yml | 16 ++++++ .github/actions/get-artifact/app/main.py | 63 ++++++++++++++++++++++++ .github/workflows/preview-docs.yml | 5 +- .gitignore | 1 + docs/en/docs/release-notes.md | 1 + scripts/unzip-docs.sh | 4 ++ 7 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 .github/actions/get-artifact/Dockerfile create mode 100644 .github/actions/get-artifact/action.yml create mode 100644 .github/actions/get-artifact/app/main.py diff --git a/.github/actions/get-artifact/Dockerfile b/.github/actions/get-artifact/Dockerfile new file mode 100644 index 000000000..1fc6a41bc --- /dev/null +++ b/.github/actions/get-artifact/Dockerfile @@ -0,0 +1,7 @@ +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 new file mode 100644 index 000000000..e19b7c983 --- /dev/null +++ b/.github/actions/get-artifact/action.yml @@ -0,0 +1,16 @@ +name: "Deploy Artifact to Netlify" +description: "Get artifact, possibly uploaded by a PR, useful to deploy docs previews" +author: "Sebastián Ramírez " +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 new file mode 100644 index 000000000..2ae1ad9ca --- /dev/null +++ b/.github/actions/get-artifact/app/main.py @@ -0,0 +1,63 @@ +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/preview-docs.yml b/.github/workflows/preview-docs.yml index 17a03b448..c46630c61 100644 --- a/.github/workflows/preview-docs.yml +++ b/.github/workflows/preview-docs.yml @@ -13,10 +13,11 @@ jobs: deploy: runs-on: ubuntu-18.04 steps: - - uses: actions/download-artifact@v2 + - uses: ./.github/actions/get-artifact with: + token: ${{ secrets.GITHUB_TOKEN }} name: ${{ github.event.inputs.name }} - path: ./docs.zip + path: ./archive.zip - name: Unzip docs run: bash ./scripts/unzip-docs.sh - name: Deploy to Netlify diff --git a/.gitignore b/.gitignore index 186c432f3..a26bb5cd6 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,7 @@ env docs_build venv docs.zip +archive.zip # vim temporary files *~ diff --git a/docs/en/docs/release-notes.md b/docs/en/docs/release-notes.md index 8298c1a18..1f8a25fe7 100644 --- a/docs/en/docs/release-notes.md +++ b/docs/en/docs/release-notes.md @@ -2,6 +2,7 @@ ## Latest changes +* Add new GitHub Actions to preview docs from PRs. PR [#1738](https://github.com/tiangolo/fastapi/pull/1738). * Add XML test coverage to support GitHub Actions. PR [#1737](https://github.com/tiangolo/fastapi/pull/1737). * Update badges and remove Travis now that GitHub Actions is the main CI. PR [#1736](https://github.com/tiangolo/fastapi/pull/1736). * Add GitHub Actions for CI, move from Travis. PR [#1735](https://github.com/tiangolo/fastapi/pull/1735). diff --git a/scripts/unzip-docs.sh b/scripts/unzip-docs.sh index f022b7deb..8e8374146 100644 --- a/scripts/unzip-docs.sh +++ b/scripts/unzip-docs.sh @@ -6,4 +6,8 @@ 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