feat: documentation preview (#203)

.github/workflows/docs_pr_preview.yml

@@ -0,0 +1,55 @@
+name: Documentation Preview
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Docs Ephemerial Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Use python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+
+      - name: Install Dependencies
+        run: cd docs && pip3 install pipenv && pipenv install
+
+      - name: Build
+        run: cd docs && pipenv run mkdocs build
+
+      - name: Archive Production Artifact
+        uses: actions/upload-artifact@master
+        with:
+          name: dist
+          path: docs/site
+
+  deploy:
+    name: Docs Ephemerial Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download Artifact
+        uses: actions/download-artifact@master
+        with:
+          name: dist
+          path: docs/site
+
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: "${{ secrets.GITHUB_TOKEN }}"
+          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
+          expires: 5d
+          projectId: fetch-docs-preview
+          entryPoint: docs/

docs/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "fetch-docs-preview"
+  }
+}

docs/.gitignore

@@ -0,0 +1,2 @@
+site/
+.firebase/

docs/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.9-slim
+RUN pip3 install pipenv
+
+WORKDIR /app
+ADD Pipfile Pipfile.lock /app/
+RUN pipenv install --system --deploy
+RUN mkdir /app/site
+
+ENTRYPOINT [ "mkdocs" ]
+CMD ["build"]

docs/build-docker.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -e
+
+TAG_NAME=fetchd-docs-build:latest
+
+# ensure the output folder is created
+mkdir -p site
+
+# build the latest image
+docker build -t "${TAG_NAME}" .
+
+docker run --rm -v "${PWD}:/app" "${TAG_NAME}"

docs/firebase.json

@@ -0,0 +1,10 @@
+{
+  "hosting": {
+    "public": "site",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  }
+}