create-grist-widget 0.2.13 → 0.2.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-grist-widget",
-  "version": "0.2.13",
+  "version": "0.2.14",
   "description": "Scaffold a new Grist custom widget from the grist-widget-sdk Vite template",
   "license": "MIT",
   "type": "module",

package/template/.github/workflows/deploy.yml

@@ -125,10 +125,14 @@ jobs:
         if: steps.plan.outputs.skip == 'true'
         run: echo "== skip — v${{ steps.plan.outputs.version }} already published"
 
-      - name: Finalize (commit + push)
+      - name: Finalize (versions.json + commit + push)
         run: |
+          UPDATE_VERSIONS=""
+          if [ "${{ steps.plan.outputs.context }}" = "release" ]; then
+            UPDATE_VERSIONS="--update-versions"
+          fi
           node scripts/deploy.mjs finalize \
-            --site site --push \
+            --site site $UPDATE_VERSIONS --push \
             --commit-message "deploy: ${{ steps.plan.outputs.context }} @ ${{ github.sha }}"
 
   cleanup:

package/template/scripts/deploy.mjs

@@ -8,6 +8,8 @@
 //   release (push to main / workflow_dispatch)
 //     - immutable  /<repo>/v<version>/   (built once, never overwritten)
 //     - mutable    /<repo>/latest/       (alias to newest release)
+//     - /<repo>/versions.json            (released-version index, newest first
+//                                        -- read by the showcase hub/notice)
 //
 //   dev (push to dev)
 //     - mutable    /<repo>/dev/          (+ version.json + self-reload)
@@ -30,10 +32,19 @@
 //     Removes dev/ from the gh-pages tree (retire the dev URL when the `dev`
 //     branch is deleted). Never touches a release or latest/.
 //
-//   finalize --site <dir> [--push] [--commit-message <msg>]
-//     Commits + pushes the gh-pages tree with a rebase-and-retry loop.
+//   finalize --site <dir> [--update-versions] [--push] [--commit-message <msg>]
+//     Regenerates versions.json (release runs only) and commits + pushes the
+//     gh-pages tree with a rebase-and-retry loop.
 
-import { existsSync, readFileSync, writeFileSync, rmSync, mkdirSync, cpSync } from "node:fs"
+import {
+  existsSync,
+  readFileSync,
+  readdirSync,
+  writeFileSync,
+  rmSync,
+  mkdirSync,
+  cpSync,
+} from "node:fs"
 import { join, dirname } from "node:path"
 import { execFileSync } from "node:child_process"
 
@@ -107,6 +118,28 @@ export function injectSelfReload(html, sha) {
   return out + snippet
 }
 
+/**
+ * Scan siteDir for previously-released v<version>/showcase-meta.json files
+ * and assemble the versions.json manifest, newest first. Read by the
+ * showcase hub (TemplateLanding) and per-channel notice (ChannelNotice) to
+ * show this widget's own release history -- not the grist-widget-sdk
+ * monorepo's (found live: every scaffolded widget's version index showed
+ * the monorepo's versions instead of its own, since showcase-versions.ts
+ * used to hardcode that URL).
+ */
+export function buildVersionsManifest(siteDir) {
+  const entries = []
+  for (const name of existsSync(siteDir) ? readdirSync(siteDir) : []) {
+    if (!/^v\d+\.\d+\.\d+/.test(name)) continue
+    const metaPath = join(siteDir, name, "showcase-meta.json")
+    if (!existsSync(metaPath)) continue
+    const meta = JSON.parse(readFileSync(metaPath, "utf8"))
+    entries.push({ version: meta.version, publishedAt: meta.publishedAt })
+  }
+  entries.sort((a, b) => new Date(b.publishedAt) - new Date(a.publishedAt))
+  return entries
+}
+
 // ----------------------------------------------------------------------------
 // Filesystem / git effects
 // ----------------------------------------------------------------------------
@@ -144,6 +177,10 @@ export function placeTarget({ siteDir, channel, version, distDir, sha, ref }) {
   // so nothing 404s.
   const versionDir = join(siteDir, `v${version}`)
   replaceDir(versionDir, distDir)
+  writeFileSync(
+    join(versionDir, "showcase-meta.json"),
+    JSON.stringify({ version, publishedAt: new Date().toISOString(), sha }, null, 2) + "\n",
+  )
   const latestDir = join(siteDir, "latest")
   replaceDir(latestDir, distDir)
   mkdirSync(siteDir, { recursive: true })
@@ -173,8 +210,12 @@ function sleep(ms) {
   while (Date.now() < end) {}
 }
 
-/** Commit + push the gh-pages tree with a rebase-and-retry loop. */
-export function finalize({ siteDir, push, commitMessage, remoteBranch = "gh-pages" }) {
+/** Regenerate versions.json (release runs only), then commit + push with rebase-retry. */
+export function finalize({ siteDir, updateVersions, push, commitMessage, remoteBranch = "gh-pages" }) {
+  if (updateVersions) {
+    const versions = buildVersionsManifest(siteDir)
+    writeFileSync(join(siteDir, "versions.json"), JSON.stringify(versions, null, 2) + "\n")
+  }
   git(["add", "-A"], siteDir)
   const status = git(["status", "--porcelain"], siteDir)
   if (!status) {
@@ -253,6 +294,7 @@ function main() {
     case "finalize": {
       const res = finalize({
         siteDir: args.site,
+        updateVersions: !!args["update-versions"],
         push: !!args.push,
         commitMessage: args["commit-message"],
       })

package/template/src/components/channel-notice.tsx

@@ -10,7 +10,7 @@ import {
 } from "@/components/ui/card"
 import { Input } from "@/components/ui/input"
 import { channelLabel, type Channel } from "@/lib/showcase-routing"
-import { DEV_URL, useVersions, versionUrl } from "@/lib/showcase-versions"
+import { devUrl, useVersions, versionUrl } from "@/lib/showcase-versions"
 import { cn } from "@/lib/utils"
 
 // Shown instead of the widget tree on a specific channel build
@@ -44,7 +44,7 @@ function VersionChips({ current }: { current: Channel }) {
           latest
         </a>
       )}
-      <a href={DEV_URL} className={chipClass(current.kind === "dev")}>
+      <a href={devUrl()} className={chipClass(current.kind === "dev")}>
         dev
       </a>
       {versions?.map((v) => (

package/template/src/components/template-landing.tsx

@@ -2,7 +2,7 @@ import { useState } from "react"
 
 import { Button } from "@/components/ui/button"
 import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs"
-import { DEV_URL, formatDate, useVersions, versionUrl } from "@/lib/showcase-versions"
+import { devUrl, formatDate, useVersions, versionUrl } from "@/lib/showcase-versions"
 
 // The showcase "hub" page: rendered whenever this deploy's URL has no
 // recognized channel suffix (see src/lib/showcase-routing.ts) -- this repo's
@@ -178,7 +178,7 @@ git push origin dev`}</code>
             Released template versions
           </h2>
           <a
-            href={DEV_URL}
+            href={devUrl()}
             className="text-sm text-muted-foreground underline underline-offset-4 hover:text-foreground"
           >
             Live dev preview →

package/template/src/lib/showcase-versions.ts

@@ -1,21 +1,35 @@
 import { useEffect, useState } from "react"
 
+import { parseShowcasePath } from "@/lib/showcase-routing"
+
 // Shared by the showcase hub (TemplateLanding) and the per-channel notice
-// (ChannelNotice) -- both need the same released-version list, fetched from
-// a fixed absolute URL rather than a path relative to wherever this happens
-// to be deployed (see src/components/template-landing.tsx for why).
-export const VERSIONS_URL =
-  "https://arthurblanchon.github.io/grist-widget-sdk/template/versions.json"
-export const DEV_URL = "https://arthurblanchon.github.io/grist-widget-sdk/template/dev/"
-export const HUB_URL = "https://arthurblanchon.github.io/grist-widget-sdk/template/"
+// (ChannelNotice) -- both need the same released-version list. URLs are
+// root-relative to wherever THIS deploy actually lives (derived from
+// window.location.pathname via parseShowcasePath's hubPath), not hardcoded
+// to the grist-widget-sdk monorepo's own showcase: a real scaffolded
+// widget has its own versions.json and its own v<version>/ + dev/ dirs,
+// and previously showed the monorepo's version history and links instead
+// of its own (found live on a real scaffold's landing page).
+function hubPath(): string {
+  const path = parseShowcasePath(window.location.pathname).hubPath
+  return path.endsWith("/") ? path : `${path}/`
+}
 
 export type ReleasedVersion = {
   version: string
   publishedAt: string
 }
 
+export function versionsUrl(): string {
+  return `${hubPath()}versions.json`
+}
+
+export function devUrl(): string {
+  return `${hubPath()}dev/`
+}
+
 export function versionUrl(version: string): string {
-  return `https://arthurblanchon.github.io/grist-widget-sdk/template/v${version}/`
+  return `${hubPath()}v${version}/`
 }
 
 export function useVersions() {
@@ -24,7 +38,7 @@ export function useVersions() {
 
   useEffect(() => {
     let cancelled = false
-    fetch(VERSIONS_URL, { cache: "no-store" })
+    fetch(versionsUrl(), { cache: "no-store" })
       .then((res) => (res.ok ? res.json() : Promise.reject(res)))
       .then((data: ReleasedVersion[]) => {
         if (!cancelled) setVersions(data)