@norskvideo/ctl-dev-kit 0.2.73 → 0.2.75

package/conventions/bump.yml

@@ -304,7 +304,9 @@ jobs:
       # @norskvideo/norsk-studio* family in whichever tracked package.json
       # depends on them) move in lockstep via a global string-replace of old->new
       # across every tracked file -- which also updates the version-pin guard
-      # test. A repo with no studio npm deps needs no `overrides` block at all.
+      # test -- except docs/internal/, whose records name the version something
+      # happened on and must keep saying so (#642). A repo with no studio npm
+      # deps needs no `overrides` block at all.
       #
       # A REFUSAL (the channels disagree, a pin is stranded, there is no
       # ctlVersion, a channel cannot be read) refuses the pins alone: the step
@@ -432,7 +434,7 @@ jobs:
           echo "studio lib:   ${old_studio_lib:-<no npm pins>} -> ${new_studio_lib:-<unchanged>}"
           echo "studio image: $old_studio_img -> $new_studio_img"
           if [ "$old_media" != "$new_media" ]; then
-            git grep -lF "$old_media" -- . ':!bun.lock' | xargs -r sed -i "s|$old_media|$new_media|g"
+            git grep -lF "$old_media" -- . ':!bun.lock' ':!docs/internal' | xargs -r sed -i "s|$old_media|$new_media|g"
             changed=1
             parts+=("media \`$new_media\`")
             moved+=("- media: $old_media -> $new_media")
@@ -441,7 +443,7 @@ jobs:
           # when the two coincide, the image ref has already moved and the
           # bare-version rewrite only touches the npm pins.
           if [ "$old_studio_img" != "$new_studio_img" ]; then
-            git grep -lF "norskvideo/norsk-studio:$old_studio_img" -- . ':!bun.lock' \
+            git grep -lF "norskvideo/norsk-studio:$old_studio_img" -- . ':!bun.lock' ':!docs/internal' \
               | xargs -r sed -i "s|norskvideo/norsk-studio:$old_studio_img|norskvideo/norsk-studio:$new_studio_img|g"
             # And the tag on its own: a product can carry it unprefixed (onair2026's
             # committed template input has `"studioTag": "<tag>"`), which the
@@ -451,13 +453,13 @@ jobs:
             if [ "$old_studio_img" != "$old_studio_lib" ]; then
               # `|| true`: after the prefixed rewrite most repos have no bare
               # occurrence left, and git grep exits 1 on no match (pipefail).
-              { git grep -lF "$old_studio_img" -- . ':!bun.lock' || true; } | xargs -r sed -i "s|$old_studio_img|$new_studio_img|g"
+              { git grep -lF "$old_studio_img" -- . ':!bun.lock' ':!docs/internal' || true; } | xargs -r sed -i "s|$old_studio_img|$new_studio_img|g"
             fi
             changed=1
             moved+=("- studio: $old_studio_img -> $new_studio_img")
           fi
           if [ -n "$new_studio_lib" ] && [ "$old_studio_lib" != "$new_studio_lib" ]; then
-            git grep -lF "$old_studio_lib" -- . ':!bun.lock' | xargs -r sed -i "s|$old_studio_lib|$new_studio_lib|g"
+            git grep -lF "$old_studio_lib" -- . ':!bun.lock' ':!docs/internal' | xargs -r sed -i "s|$old_studio_lib|$new_studio_lib|g"
             changed=1
             moved+=("- studio-lib: $old_studio_lib -> $new_studio_lib")
           fi

package/create-product/canon.ts

@@ -26,6 +26,7 @@ export interface Canon {
   dprint: string;
   buildImageBootstrap: string;
   buildImage: string;
+  smoke: string;
   /** conventions/build-docs.yml — the embedded docs workflow a turnkey carries. */
   buildDocs: string;
   gitignoreCore: string;
@@ -53,6 +54,7 @@ export function loadCanon(): Canon {
     dprint: readFileSync(join(conventionsDir, "dprint.base.jsonc"), "utf8"),
     buildImageBootstrap: readFileSync(join(buildDir, "build-image.bootstrap.sh"), "utf8"),
     buildImage: readFileSync(join(conventionsDir, "build-image.yml"), "utf8"),
+    smoke: readFileSync(join(conventionsDir, "smoke.yml"), "utf8"),
     gitignoreCore: readFileSync(join(conventionsDir, "gitignore.core"), "utf8"),
     invariantsTemplate: readFileSync(join(import.meta.dir, "..", "testing", "INVARIANTS.template.md"), "utf8"),
     demoShim: readFileSync(join(conventionsDir, "demo.sh"), "utf8"),

package/create-product/create-product.ts

@@ -223,6 +223,7 @@ function conventionFiles(ctx: ShapeContext, shape: ShapeModule): GeneratedFile[]
     { path: ".github/workflows/bump.yml", content: fillProduct(canon.bump) },
     { path: ".github/workflows/bot-prs.yml", content: canon.botPrs },
     { path: ".github/workflows/build-image.yml", content: fillProduct(canon.buildImage) },
+    { path: ".github/workflows/smoke.yml", content: fillProduct(canon.smoke) },
     { path: ".github/actions/ci-status-dispatch/action.yml", content: loadAsset("ci-status-dispatch.yml") },
     { path: "manifest.seed.json", content: seedJson(ctx) },
     { path: "licenseTemplate.json", content: licenseTemplateJson(ctx) },

package/create-product/turnkey.ts

@@ -257,9 +257,15 @@ refreshed \`~/.norsk-ctl/product-templates/<name>/compose.yml\` carries the pins
   so table and tests cannot drift apart.
 - **Layer 4 — studio-load round-trip** (\`tests/unit/loads-in-studio.test.ts\`):
   emitted YAML through Studio's real \`document.load()\`.
-- **Layer 5 — integration**: not scaffolded. Decide + record here whether this
-  product carries one (unattended nightly bumps need it; see
+- **Layer 5 — integration**: the smoke tier (\`tests/smoke.spec.ts\`, run by
+  the convention \`smoke.yml\` on PRs, main and the nightly bump). It launches
+  the built image, sends the camera1 sample to the SRT ingest and checks the
+  graph is up and the ingest connected. Grow its observations as the product
+  takes shape; add an \`integration.yml\` when a regression needs more than
+  one journey (see
   \`node_modules/@norskvideo/ctl-dev-kit/conventions/integration-testing.md\`).
+  Locally: \`bun run build:image && bun run test:smoke\` with
+  \`NORSK_LICENSE_FILE\` set.
 
 Byte-snapshots (\`tests/unit/workflow-snapshot.test.ts\`) pin the emitted wire
 bytes; \`UPDATE_SNAPSHOTS=1\` refreshes deliberately.
@@ -303,6 +309,7 @@ function rootPackageJson(ctx: ShapeContext): string {
         test: "bun run test:unit",
         "test:unit": `bun test shared/src/ backend/src/ ${hasComponents ? "components/src/ " : ""}tests/unit/`,
         "test:image": "bun test tests/image/",
+        "test:smoke": "NORSK_CTL_ENV=test bun test tests/smoke.spec.ts",
         "check:drift": "bun run node_modules/@norskvideo/ctl-dev-kit/conventions/check-drift.ts",
         "docs:check":
           "bun run node_modules/@norskvideo/ctl-dev-kit/docs/path-existence.ts && bun run node_modules/@norskvideo/ctl-dev-kit/docs/light-pages.ts && bun run node_modules/@norskvideo/ctl-dev-kit/docs/journeys.ts",
@@ -1825,6 +1832,49 @@ exec bun run demo -- up --mode image --daemon reuse
 `;
 }
 
+function smokeSpecTs(ctx: ShapeContext): string {
+  return `// The smoke tier: one journey through the built image, run by
+// @norskvideo/ctl-test-harness/smoke on PRs, main and the nightly bump.
+// smoke.yml builds the image and sets SMOKE_IMAGE_TAG; locally,
+// \`bun run build:image && bun run test:smoke\` with NORSK_LICENSE_FILE set.
+// The tag must be one the licence names (licenseTemplate.json).
+//
+// The camera1 sample goes to the SRT ingest. What it proves: the graph is up
+// and the ingest takes the feed. Grow the observations as the product takes
+// shape: they are what an unattended nightly bump is trusted on.
+import { test } from "bun:test";
+import { hashSlot } from "@norskvideo/ctl-test-harness/harness-config";
+import { runProductSmoke } from "@norskvideo/ctl-test-harness/smoke";
+
+// The listener inside the media container (the configured default), which the
+// pump dials on the docker network.
+const LISTENER_PORT = 5001;
+// The host side of that publish, moved off 5001: other products' smokes (and a
+// running demo) hold it on a shared runner.
+const INGEST_HOST_PORT = 27001 + hashSlot("${ctx.name}", 40) * 4;
+
+test(
+  "${ctx.name}: the graph comes up and takes the SRT feed",
+  () =>
+    runProductSmoke("${ctx.name}", {
+      product: {
+        name: "${ctx.name}",
+        register: { image: process.env.SMOKE_IMAGE_TAG ?? "${ctx.name}:dev" },
+      },
+      template: { name: "default" },
+      params: [\`INGEST_PORT=\${INGEST_HOST_PORT}\`],
+      hardware: "none",
+      sources: [{ port: LISTENER_PORT, name: "input", streamId: "input", preset: "camera1" }],
+      observe: [
+        { kind: "components", ids: ["ingest", "egest"] },
+        { kind: "srt-connected", componentId: "ingest" },
+      ],
+    }),
+  600_000,
+);
+`;
+}
+
 function demoSpecTs(ctx: ShapeContext): string {
   return `// The ${ctx.name} demo (fleet review 05-demo): the manifest's default
 // template with the daemon's camera1 sample pumped into the SRT ingest. Run by
@@ -2222,6 +2272,7 @@ export const turnkey: ShapeModule = {
       { path: "scripts/with-display.sh", content: ctx.canon.withDisplay, executable: true },
       { path: "scripts/docs-handover.sh", content: DOCS_HANDOVER_SH, executable: true },
       { path: "tests/demo.spec.ts", content: demoSpecTs(ctx) },
+      { path: "tests/smoke.spec.ts", content: smokeSpecTs(ctx) },
       { path: "tests/unit/demo-spec.test.ts", content: DEMO_SPEC_TEST_TS },
       { path: "shared/package.json", content: sharedPackageJson(ctx) },
       { path: "shared/tsconfig.json", content: WORKSPACE_TSCONFIG },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norskvideo/ctl-dev-kit",
-  "version": "0.2.73",
+  "version": "0.2.75",
   "type": "module",
   "exports": {
     "./create-product": "./create-product/create-product.ts",