deploy from github actions

Author: minrk

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "pypi"
+    directory: "/"
+    # needed to update requirements.txt
+    allow:
+      - dependency-type: all
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 3
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 3

.github/workflows/cd.yml

@@ -0,0 +1,76 @@
+name: Continuous Deployment
+
+# only allow one deploy workflow to be running at a time
+# serializes multiple outstanding deploys if PRs are merged before the last deploy finishes
+# ref: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency
+concurrency: deploy
+
+# Only trigger the workflow when pushing to master or a label is applied to a
+# Pull Request
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "*.md"
+      - .pre-commit-config.yaml
+      - .github/**
+      - "!.github/workflows/cd.yml"
+
+# Global environment variables
+env:
+  KUBECTL_VERSION: "v1.29.15"
+  HELM_VERSION: "v3.12.0"
+  KUBECONFIG: secrets/ovh-kubeconfig.yaml
+
+jobs:
+  # In this dedicated job to deploy our staging environment we build and push
+  # images that the jobs to deploy to the production environments depend on.
+  deploy:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: "Stage 1: Install dependencies"
+        run: |
+          pip install --upgrade setuptools pip
+          pip install --upgrade -r requirements.txt
+
+      - name: "Stage 1: Install kubectl ${{ env.KUBECTL_VERSION }}"
+        uses: azure/setup-kubectl@v4
+        with:
+          version: ${{ env.KUBECTL_VERSION }}
+
+      - name: "Stage 1: Install and setup helm ${{ env.HELM_VERSION }}"
+        run: |
+          curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | DESIRED_VERSION=${HELM_VERSION} bash
+
+      - name: Unlock git-crypt secrets
+        uses: sliteteam/github-action-git-crypt-unlock@f99c0c6b60bb7ec30dcec033a8f0a3b3d48f21e1
+        env:
+          GIT_CRYPT_KEY: ${{ secrets.GIT_CRYPT_KEY }}
+
+      - name: get nbviewer chart
+        run: |
+          git clone https://github.com/jupyter/nbviewer
+          cd nbviewer
+          git reset "${NBVIEWER_VERSION}" --hard
+          git log -1
+
+      - name: deploy
+        run: |
+          bash deploy.sh
+
+      - name: "Test"
+        run: |
+          pytest

.gitignore

@@ -52,3 +52,5 @@ coverage.xml
 # Sphinx documentation
 docs/_build/
 
+.ipynb_checkpoints
+.DS_Store

deploy.sh

@@ -4,23 +4,29 @@ set -euo pipefail
 # TODO: move this to CI, don't make assumptions about local repo checkouts
 
 export KUBECONFIG=$PWD/secrets/ovh-kubeconfig.yaml
-nbviewer_chart="../nbviewer/helm-chart/nbviewer"
-echo "Is $PWD/../nbviewer up to date?"
+
+nbviewer_chart="${NBVIEWER_CHART:-../nbviewer/helm-chart/nbviewer}"
+echo "Is $nbviewer_chart up to date?"
 helm dep up $nbviewer_chart
 
 upgrade="upgrade nbviewer $nbviewer_chart -f config/nbviewer.yaml -f secrets/config/nbviewer.yaml"
 helm diff -C 5 $upgrade
+exit 1
 
-echo "Deploy these changes? (y|[N]) "
-read confirm
+if [[ -z "${CI:-}" ]]; then
+  echo "Deploy these changes? (y|[N]) "
+  read confirm
 
-if [[ "$confirm" == "y" || "$confirm" == "Y" ]]; then
-  echo "Upgrading..."
-  helm $upgrade
-else
-  echo "Cancelled"
-  exit 1
+  if [[ "$confirm" == "y" || "$confirm" == "Y" ]]; then
+    echo "confirmed"
+  else
+    echo "Cancelled"
+    exit 1
+  fi
 fi
 
+echo "Upgrading..."
+helm $upgrade --cleanup-on-fail
+
 # watch deployment rollout
 kubectl rollout status -w deployment/nbviewer

pyproject.toml

@@ -0,0 +1,9 @@
+
+[project]
+name = "nbviewer.org-deploy"
+
+[tool.pytest.ini_options]
+addopts = "-v"
+testpaths = [
+    "tests",
+]

requirements.in

@@ -0,0 +1,2 @@
+pytest
+requests

requirements.txt

@@ -1,2 +1,26 @@
-invoke>=0.13
-requests
+#
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
+#
+#    pip-compile
+#
+certifi==2025.8.3
+    # via requests
+charset-normalizer==3.4.3
+    # via requests
+idna==3.10
+    # via requests
+iniconfig==2.1.0
+    # via pytest
+packaging==25.0
+    # via pytest
+pluggy==1.6.0
+    # via pytest
+pygments==2.19.2
+    # via pytest
+pytest==8.4.2
+    # via -r requirements.in
+requests==2.32.5
+    # via -r requirements.in
+urllib3==2.5.0
+    # via requests

tests/test_nbviewer.py

@@ -0,0 +1,24 @@
+import pytest
+import requests
+from bs4 import BeautifulSoup
+
+
+NBVIEWER = "https://nbviewer.org"
+
+frontpage_request = requests.get(NBVIEWER)
+frontpage = BeautifulSoup(frontpage_request.text, "html.parser")
+frontpage_links = frontpage.find_all("a", class_="thumbnail")
+frontpage_urls = [a["href"] for a in frontpage_links]
+
+
+def test_main_page():
+    frontpage_request.raise_for_status()
+    assert frontpage_request.status_code == 200
+    assert len(frontpage_urls) > 5
+
+
+@pytest.mark.parametrize("path", frontpage_urls)
+def test_front_page(path):
+    url = f"{NBVIEWER}{path}"
+    r = requests.get(url)
+    assert r.status_code == 200