Merge branch 'main' into fix/restore-cross-platform-builds

Author: EtienneLescot

.github/workflows/docs.yml

@@ -11,6 +11,14 @@ on:
     paths:
       - "website/**"
       - ".github/workflows/docs.yml"
+  # The /download page resolves the current release's assets at build time so it
+  # can link each platform to its actual file. Without this trigger that data
+  # would freeze at whatever the last website/** change saw, and the page would
+  # keep serving the previous version's binaries after every release.
+  # Pre-releases are skipped: /releases/latest ignores them, so the built output
+  # would be byte-identical.
+  release:
+    types: [published]
   workflow_dispatch:
 
 # Cancel in-flight runs on the same ref so fast follow-up pushes
@@ -26,6 +34,9 @@ jobs:
   build:
     name: Build site
     runs-on: ubuntu-latest
+    # A pre-release does not change what /releases/latest resolves to, so
+    # rebuilding for one would burn a run to produce identical output.
+    if: github.event_name != 'release' || github.event.release.prerelease == false
     steps:
       - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
@@ -53,7 +64,9 @@ jobs:
     name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
     needs: build
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    if: >-
+      (github.event_name == 'push' && github.ref == 'refs/heads/main')
+      || github.event_name == 'release'
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}

website/docusaurus.config.ts

@@ -2,8 +2,11 @@ import type * as Preset from "@docusaurus/preset-classic";
 import type { Config } from "@docusaurus/types";
 import { themes as prismThemes } from "prism-react-renderer";
 
+import type { LatestRelease } from "./src/lib/release";
+
 const SITE_URL = "https://getopenscreen.com";
-const REPO_URL = "https://github.com/getopenscreen/openscreen";
+const REPO_SLUG = "getopenscreen/openscreen";
+const REPO_URL = `https://github.com/${REPO_SLUG}`;
 const UPSTREAM_REPO_URL = "https://github.com/siddharthvaddem/openscreen";
 const DISCORD_URL = "https://discord.gg/VvT6Vtnyh";
 
@@ -64,8 +67,73 @@ async function fetchStarCount(): Promise<number | null> {
 	}
 }
 
+const MONTHS = [
+	"January",
+	"February",
+	"March",
+	"April",
+	"May",
+	"June",
+	"July",
+	"August",
+	"September",
+	"October",
+	"November",
+	"December",
+];
+
+/**
+ * The published assets for the current stable release, resolved at build time
+ * so /download can link each platform to its actual file instead of bouncing
+ * everyone through the releases list.
+ *
+ * This is only safe because .github/workflows/docs.yml also rebuilds on
+ * `release: published`. Without that trigger the data would go stale silently —
+ * the workflow otherwise only fires on website/** changes, so shipping a new
+ * version would leave this page advertising the previous one indefinitely.
+ *
+ * Returns null on any failure (the API is called unauthenticated, so a
+ * rate-limited runner is a real possibility); the page falls back to
+ * /releases/latest links, which are always correct.
+ */
+async function fetchLatestRelease(): Promise<LatestRelease> {
+	try {
+		const res = await fetch(`https://api.github.com/repos/${REPO_SLUG}/releases/latest`, {
+			headers: { Accept: "application/vnd.github+json" },
+			signal: AbortSignal.timeout(5000),
+		});
+		if (!res.ok) return null;
+		const data = (await res.json()) as {
+			tag_name?: unknown;
+			published_at?: unknown;
+			assets?: unknown;
+		};
+		if (typeof data.tag_name !== "string" || !Array.isArray(data.assets)) return null;
+
+		const assets = data.assets.flatMap((raw) => {
+			const a = raw as { name?: unknown; browser_download_url?: unknown; size?: unknown };
+			if (typeof a.name !== "string" || typeof a.browser_download_url !== "string") return [];
+			return [{ name: a.name, url: a.browser_download_url, size: Number(a.size) || 0 }];
+		});
+		if (assets.length === 0) return null;
+
+		// Formatted here rather than in the component: toLocaleDateString would
+		// resolve against the visitor's locale and time zone on hydration and
+		// mismatch the server-rendered string.
+		let published = "";
+		if (typeof data.published_at === "string") {
+			const [y, m, d] = data.published_at.slice(0, 10).split("-");
+			if (y && m && d) published = `${Number(d)} ${MONTHS[Number(m) - 1]} ${y}`;
+		}
+
+		return { tag: data.tag_name, published, assets };
+	} catch {
+		return null;
+	}
+}
+
 export default async function createConfig(): Promise<Config> {
-	const starCount = await fetchStarCount();
+	const [starCount, latestRelease] = await Promise.all([fetchStarCount(), fetchLatestRelease()]);
 	const starBadge =
 		starCount !== null
 			? `<span class="navbar-github-stars">${STAR_SVG}${formatStarCount(starCount)}</span>`
@@ -93,6 +161,10 @@ export default async function createConfig(): Promise<Config> {
 		organizationName: "getopenscreen",
 		projectName: "openscreen",
 
+		// Read back by src/pages/download.tsx. Serialized into the client bundle,
+		// so it stays plain JSON.
+		customFields: { latestRelease },
+
 		onBrokenLinks: "throw",
 		onBrokenAnchors: "throw",
 

website/src/lib/release.ts

@@ -0,0 +1,44 @@
+/**
+ * Shape of the build-time GitHub release lookup, shared between the config that
+ * fetches it (docusaurus.config.ts) and the page that renders it
+ * (src/pages/download.tsx), which reads it back off siteConfig.customFields.
+ */
+
+export type ReleaseAsset = {
+	name: string;
+	url: string;
+	size: number;
+};
+
+/** null whenever the build-time lookup failed; callers must handle it. */
+export type LatestRelease = {
+	tag: string;
+	/** Pre-formatted at build time, e.g. "19 July 2026". Empty if unknown. */
+	published: string;
+	assets: ReleaseAsset[];
+} | null;
+
+/**
+ * Asset filenames carry the version (Openscreen-Mac-arm64-1.7.0.dmg), so these
+ * match on the stable parts only — platform, arch, and extension — and keep
+ * working across releases without a config change.
+ */
+export const ASSET_PATTERNS = {
+	macArm: /Mac.*arm64.*\.dmg$/i,
+	macIntel: /Mac.*x64.*\.dmg$/i,
+	windows: /\.exe$/i,
+	deb: /\.deb$/i,
+	pacman: /\.pacman$/i,
+	appImage: /\.AppImage$/i,
+} as const;
+
+export type AssetKind = keyof typeof ASSET_PATTERNS;
+
+export function findAsset(release: LatestRelease, kind: AssetKind): ReleaseAsset | null {
+	return release?.assets.find((a) => ASSET_PATTERNS[kind].test(a.name)) ?? null;
+}
+
+export function formatSize(bytes: number): string {
+	if (!bytes) return "";
+	return `${Math.round(bytes / 1048576)} MB`;
+}