@pantheon-systems/create-p1-starter-kit 0.11.1 → 0.13.0

package/template/scripts/sync-puck-registry.ts

@@ -2,23 +2,23 @@
  * Syncs this site's Puck component registry (_registry/components/* and the
  * registry index) headlessly, without opening the editor in a browser.
  * Intended to run from CI on push to main or a branch whose name matches a
- * CSS branch, whenever puck.config.tsx or components/puck/** change.
+ * branch on the site, whenever puck.config.tsx or components/puck/** change.
  *
  * Usage: tsx scripts/sync-puck-registry.ts [--dry-run]
  *
  * Required env vars (see validateEnv below for the full fallback contract):
  *   CSS_BASE_URL, CSS_SITE_ID, CSS_REGISTRY_API_KEY
  * Optional:
- *   CSS_BRANCH_ID — CSS branch to target (in CI: the pushed git ref's name)
+ *   CSS_BRANCH_ID — branch to target (in CI: the pushed git ref's name)
  *   CSS_DEFAULT_BRANCH — the repo's default branch name (defaults to "main");
  *   when CSS_BRANCH_ID equals it, the site's isMain branch is targeted
  *   regardless of naming (see resolveBranchId for the resolution contract)
  *
  * CSS_REGISTRY_API_KEY must be a sat_ site token scoped to write:registry
  * only — do not reuse a read-scoped token (P1_CSS_API_KEY). Because that
- * token has no read access at all, every run rewrites every component
- * descriptor + the registry index unconditionally (no skip-if-unchanged) —
- * see syncComponentRegistryWriteOnly.
+ * token has no read access at all, every run posts every component
+ * descriptor + the registry index; the backend compares each against stored
+ * content and writes only what changed — see syncComponentRegistryWriteOnly.
  */
 
 import { register } from "node:module";
@@ -43,7 +43,7 @@ export function validateEnv(env: Record<string, string | undefined>): ValidatedE
   const siteId = env.CSS_SITE_ID ?? env.NEXT_PUBLIC_CSS_SITE_ID;
   const apiKey = env.CSS_REGISTRY_API_KEY;
   const branchOverride = env.CSS_BRANCH_ID ?? env.NEXT_PUBLIC_CSS_BRANCH_ID;
-  // Defaults to "main": the CSS main content branch is always literally
+  // Defaults to "main": the site's main content branch is always literally
   // named "main", so for repos whose default git branch is also "main" this
   // resolves to the same branch it would have matched by name. Repos with a
   // differently-named default branch (master, trunk) must set it explicitly.
@@ -88,10 +88,10 @@ export function resolveConfigModule(mod: unknown): unknown {
 }
 
 /**
- * Thrown by resolveBranchId when no CSS branch matches. Distinguished from
- * other errors so callers (main(), a CI trigger firing on every git branch)
- * can treat "this branch has no CSS counterpart" as a benign no-op rather
- * than a real sync failure.
+ * Thrown by resolveBranchId when no matching branch is found. Distinguished
+ * from other errors so callers (main(), a CI trigger firing on every git
+ * branch) can treat "this branch has no counterpart on the site" as a benign
+ * no-op rather than a real sync failure.
  */
 export class NoBranchMatchError extends Error {}
 
@@ -133,12 +133,12 @@ export function filterAssetStubbedDescriptors(descriptors: Descriptor[]): {
 
 /**
  * Resolution contract: an override (in CI, always the pushed git ref's name)
- * matches a CSS branch by id or name — EXCEPT when it equals the repo's
- * default branch name, which always resolves the site's isMain branch. CSS
- * main is always literally named "main", so without that rule a repo whose
- * default branch is "master"/"trunk" would silently skip on every push. The
- * default branch means the main registry, even over a coincidental CSS
- * branch named e.g. "master".
+ * matches a branch on the site by id or name — EXCEPT when it equals the
+ * repo's default branch name, which always resolves the site's isMain
+ * branch. The site's main branch is always literally named "main", so
+ * without that rule a repo whose default branch is "master"/"trunk" would
+ * silently skip on every push. The default branch means the main registry,
+ * even over a coincidentally-named branch on the site, e.g. "master".
  */
 export function resolveBranchId(
   branches: Branch[],
@@ -211,8 +211,8 @@ const isMainModule = import.meta.url === pathToFileURL(process.argv[1] ?? "").hr
 if (isMainModule) {
   main().catch((err: unknown) => {
     // A CI trigger firing on every git branch push has no way to know ahead
-    // of time which branches have a matching CSS branch — that has to be
-    // discovered at runtime. Treat "no match" as a benign no-op, not a
+    // of time which branches have a matching branch on the site — that has
+    // to be discovered at runtime. Treat "no match" as a benign no-op, not a
     // failure, so unrelated feature-branch pushes don't turn CI red.
     if (err instanceof NoBranchMatchError) {
       console.log(`[sync-puck-registry] Skipping: ${err.message}`);

package/template/CHANGELOG.md

@@ -1,76 +0,0 @@
-# @pantheon-systems/p1-starter
-
-## 1.0.7
-
-### Patch Changes
-
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies [3ed945e]
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-- Updated dependencies
-  - @pantheon-systems/puck-css@0.8.0
-  - @pantheon-systems/p1-next-sdk@0.8.0
-  - @pantheon-systems/css-client@0.8.0
-
-## 1.0.6
-
-### Patch Changes
-
-- Updated dependencies [b0254ff]
-- Updated dependencies
-- Updated dependencies [e937842]
-- Updated dependencies [e937842]
-  - @pantheon-systems/puck-css@0.7.0
-  - @pantheon-systems/css-client@0.7.0
-  - @pantheon-systems/p1-next-sdk@0.7.0
-
-## 1.0.5
-
-### Patch Changes
-
-- @pantheon-systems/puck-css@0.6.0
-- @pantheon-systems/p1-next-sdk@0.6.0
-
-## 1.0.4
-
-### Patch Changes
-
-- Updated dependencies [0bc7982]
-  - @pantheon-systems/puck-css@0.5.0
-  - @pantheon-systems/p1-next-sdk@0.5.0
-
-## 1.0.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @pantheon-systems/puck-css@0.4.4
-  - @pantheon-systems/p1-next-sdk@0.4.4
-  - @pantheon-systems/css-client@0.4.4
-
-## 1.0.2
-
-### Patch Changes
-
-- Updated dependencies
-  - @pantheon-systems/puck-css@0.4.3
-  - @pantheon-systems/p1-next-sdk@0.4.3
-  - @pantheon-systems/css-client@0.4.3
-
-## 1.0.1
-
-### Patch Changes
-
-- Updated dependencies [6650602]
-- Updated dependencies [dc7cfd7]
-  - @pantheon-systems/puck-css@0.4.2
-  - @pantheon-systems/css-client@0.4.2
-  - @pantheon-systems/p1-next-sdk@0.4.2