Add warning about being ahead of release (#525)

Author: samuelcolvin

docs/overrides/.icons/logfire/logo.svg renamed to docs/.overrides/.icons/logfire/logo.svg

@@ -0,0 +1,14 @@
+{% extends "base.html" %}
+{% block content %}
+  <div id="version-warning" style="min-height: 120px"></div>
+  <script>
+    fetch('/version-warning.html').then(r => {
+      if (r.ok) {
+        r.text().then(text => { document.getElementById('version-warning').innerHTML = text })
+    } else {
+        r.text().then(text => { console.error('failed to fetch ahead-warning.html:', {r, text})})
+      }
+    })
+  </script>
+  {{ super() }}
+{% endblock %}

docs/.overrides/main.html

@@ -0,0 +1,62 @@
+// cloudflare worker to building warning if the docs are ahead of the latest release
+// see https://developers.cloudflare.com/pages/functions/advanced-mode/
+
+export default {
+  async fetch(request, env) {
+    const url = new URL(request.url)
+    if (url.pathname === '/version-warning.html') {
+      try {
+        const html = await versionWarning(request, env)
+        return new Response(html, { headers: {'Content-Type': 'text/html', 'Cache-Control': 'max-age=1800'} })
+      } catch (e) {
+        console.error(e)
+        return new Response(
+          `Error getting ahead HTML: ${e}`,
+          { status: 500, headers: {'Content-Type': 'text/plain'} }
+        )
+      }
+    } else {
+      return env.ASSETS.fetch(request)
+    }
+  },
+}
+
+// env looks like
+// {"CF_PAGES":"1","CF_PAGES_BRANCH":"ahead-warning","CF_PAGES_COMMIT_SHA":"...","CF_PAGES_URL":"https://..."}
+async function versionWarning(request, env) {
+  const headers = new Headers({
+    'User-Agent': request.headers.get('User-Agent') || 'pydantic-ai-docs',
+    'Accept': 'application/vnd.github.v3+json',
+  })
+  const r1 = await fetch('https://api.github.com/repos/pydantic/pydantic-ai/releases/latest', {headers})
+  if (!r1.ok) {
+    const text = await r1.text()
+    throw new Error(`Failed to fetch latest release, response status ${r1.status}:\n${text}`)
+  }
+  const {html_url, name, tag_name} = await r1.json()
+  const r2 = await fetch(
+    `https://api.github.com/repos/pydantic/pydantic-ai/compare/${tag_name}...${env.CF_PAGES_COMMIT_SHA}`,
+    {headers}
+  )
+  if (!r2.ok) {
+    const text = await r2.text()
+    throw new Error(`Failed to fetch compare, response status ${r2.status}:\n${text}`)
+  }
+  const {ahead_by} = await r2.json()
+
+  if (ahead_by === 0) {
+    return `<div class="admonition success" style="margin: 0">
+  <p class="admonition-title">Version</p>
+  <p>Showing documentation for the latest release <a href="${html_url}">${name}</a>.</p>
+</div>`
+  }
+
+  return `<div class="admonition info" style="margin: 0">
+  <p class="admonition-title">Version Notice</p>
+  <p>
+    ${env.CF_PAGES_BRANCH === 'main' ? '' : `(<b>${env.CF_PAGES_BRANCH}</b> preview)`}
+    This documentation is ahead of the latest release by <b>${ahead_by}</b> commit${ahead_by === 1 ? '' : 's'}.
+    You may see documentation for features not yet supported in the latest release <a href="${html_url}">${name}</a>.
+  </p>
+</div>`
+}

docs/_worker.js

@@ -57,7 +57,7 @@ extra:
 
 theme:
   name: "material"
-  custom_dir: docs/overrides
+  custom_dir: docs/.overrides
   palette:
     - media: "(prefers-color-scheme)"
       scheme: default
@@ -105,7 +105,7 @@ validation:
   anchors: warn
 
 extra_css:
-  - 'extra/tweaks.css'
+  - "extra/tweaks.css"
 # used for analytics
 extra_javascript:
   - "/flarelytics/client.js"