@ontrails/trails 0.2.0

package/src/trails/release-check.ts

@@ -0,0 +1,113 @@
+/**
+ * `release.check` trail -- Branch-local release rule evaluation.
+ */
+
+import { Result, trail, ValidationError } from '@ontrails/core';
+import { z } from 'zod';
+
+import { runReleaseCheck } from '../release/check.js';
+import { resolveTrailRootDir } from './root-dir.js';
+
+const releaseCheckInputSchema = z.object({
+  baseRef: z
+    .string()
+    .optional()
+    .describe('Base git ref for changed-file and contract fact comparison'),
+  changedFiles: z
+    .string()
+    .optional()
+    .describe('Path to a newline-delimited changed-file list'),
+  configPath: z.string().optional().describe('Path to trails.config.ts'),
+  releaseNone: z
+    .boolean()
+    .default(false)
+    .describe('Compatibility no-release override'),
+  rootDir: z.string().optional().describe('Workspace root directory'),
+});
+
+const contractReleaseFactAspectSchema = z.enum([
+  'input',
+  'output',
+  'surfaces',
+  'trail',
+  'visibility',
+]);
+
+const contractReleaseFactSchema = z.object({
+  aspect: contractReleaseFactAspectSchema,
+  baseHash: z.string().nullable(),
+  changedFiles: z.array(z.string()).readonly(),
+  currentHash: z.string().nullable(),
+  packageName: z.string().optional(),
+  path: z.string(),
+  trailId: z.string(),
+  workspacePath: z.string().optional(),
+});
+
+const packageRouteReleaseFactSchema = z.object({
+  kind: z.enum(['classified', 'single']),
+  sourcePackage: z.string(),
+  targetPackage: z.string().optional(),
+  transitionId: z.string(),
+});
+
+const releaseCheckOutputSchema = z.object({
+  activePackageChangesetsWithoutReleaseFacts: z.array(z.string()).readonly(),
+  affectedPackages: z.array(z.string()).readonly(),
+  changedChangesets: z.array(z.string()).readonly(),
+  configPath: z.string().optional(),
+  contractFacts: z.array(contractReleaseFactSchema).readonly(),
+  coveredPackages: z.array(z.string()).readonly(),
+  errors: z.array(z.string()).readonly(),
+  formatted: z.string(),
+  matchedRuleIds: z.array(z.string()).readonly(),
+  noReleaseOverride: z.boolean(),
+  packageRouteFacts: z.array(packageRouteReleaseFactSchema).readonly(),
+  passed: z.boolean(),
+  releaseNone: z.boolean(),
+  uncoveredContractFacts: z.array(contractReleaseFactSchema).readonly(),
+  versionRelease: z.boolean(),
+});
+
+export const releaseCheckTrail = trail('release.check', {
+  description: 'Check branch-local release rules',
+  examples: [
+    {
+      input: { baseRef: 'HEAD' },
+      name: 'Check release rules from the current HEAD',
+    },
+  ],
+  implementation: async (input, ctx) => {
+    const rootDirResult = resolveTrailRootDir(input.rootDir, ctx.cwd);
+    if (rootDirResult.isErr()) {
+      return rootDirResult;
+    }
+
+    try {
+      return Result.ok(
+        await runReleaseCheck({
+          ...(input.baseRef === undefined ? {} : { baseRef: input.baseRef }),
+          ...(input.changedFiles === undefined
+            ? {}
+            : { changedFilesPath: input.changedFiles }),
+          ...(input.configPath === undefined
+            ? {}
+            : { configPath: input.configPath }),
+          env: ctx.env ?? {},
+          releaseNone: input.releaseNone,
+          repoRoot: rootDirResult.value,
+        })
+      );
+    } catch (error) {
+      return Result.err(
+        new ValidationError(
+          error instanceof Error ? error.message : String(error)
+        )
+      );
+    }
+  },
+  input: releaseCheckInputSchema,
+  intent: 'read',
+  output: releaseCheckOutputSchema,
+  permit: 'public',
+});

package/src/trails/release-smoke.ts

@@ -0,0 +1,49 @@
+/**
+ * `release.smoke` trail -- Local release confidence checks.
+ */
+
+import { Result, trail, ValidationError } from '@ontrails/core';
+import { z } from 'zod';
+
+import { releaseSmokeCheckValues, runReleaseSmoke } from '../release/smoke.js';
+
+const releaseSmokeCheckSchema = z.enum(releaseSmokeCheckValues);
+
+const releaseSmokeInputSchema = z.object({
+  check: z.string().default('all').describe('Release smoke check to run'),
+});
+
+const releaseSmokeCheckResultSchema = z.object({
+  check: z.enum(['lock-roundtrip', 'packed-artifacts', 'wayfinder-dogfood']),
+  lockCount: z.number().optional(),
+  message: z.string(),
+  packageCount: z.number().optional(),
+  passed: z.literal(true),
+  trailCount: z.number().optional(),
+});
+
+const releaseSmokeOutputSchema = z.object({
+  checks: z.array(releaseSmokeCheckResultSchema).readonly(),
+  message: z.string(),
+  passed: z.literal(true),
+});
+
+export const releaseSmokeTrail = trail('release.smoke', {
+  description: 'Run local release confidence smoke checks',
+  implementation: async (input) => {
+    try {
+      const check = releaseSmokeCheckSchema.parse(input.check);
+      return Result.ok(await runReleaseSmoke(check));
+    } catch (error) {
+      return Result.err(
+        new ValidationError(
+          error instanceof Error ? error.message : String(error)
+        )
+      );
+    }
+  },
+  input: releaseSmokeInputSchema,
+  intent: 'read',
+  output: releaseSmokeOutputSchema,
+  permit: 'public',
+});

package/src/trails/revise.ts

@@ -0,0 +1,53 @@
+import { Result, ValidationError, trail } from '@ontrails/core';
+import { z } from 'zod';
+
+import {
+  findLifecycleTrail,
+  forkVersionEntrySource,
+  parseLifecycleTarget,
+  reviseTrailSource,
+  withLifecycleApp,
+} from './version-lifecycle-support.js';
+
+export const reviseTrail = trail('revise', {
+  args: ['target'],
+  description: 'Scaffold the next trail version entry',
+  implementation: async (input, ctx) =>
+    withLifecycleApp(input, ctx.cwd, async (app, rootDir) => {
+      const target = parseLifecycleTarget(input.target);
+      if (target.isErr()) {
+        return target;
+      }
+      if (target.value.version !== undefined) {
+        return input.as === 'fork'
+          ? forkVersionEntrySource(rootDir, target.value)
+          : Result.err(
+              new ValidationError(
+                'Revising a specific historical entry requires --as fork'
+              )
+            );
+      }
+      const found = findLifecycleTrail(app, target.value.trailId);
+      if (found.isErr()) {
+        return found;
+      }
+      return reviseTrailSource(rootDir, found.value, input.as);
+    }),
+  input: z.object({
+    as: z
+      .enum(['revision', 'fork'])
+      .default('revision')
+      .describe('Version entry shape to scaffold'),
+    module: z.string().optional().describe('Path to the app module'),
+    rootDir: z.string().optional().describe('Workspace root directory'),
+    target: z.string().min(1).describe('Trail target, optionally trail.id@N'),
+  }),
+  intent: 'write',
+  output: z.object({
+    filePath: z.string(),
+    trailId: z.string(),
+    updated: z.boolean(),
+    warnings: z.array(z.string()).optional(),
+  }),
+  permit: { scopes: ['version:write'] },
+});

package/src/trails/root-dir.ts

@@ -0,0 +1,21 @@
+import { Result, ValidationError } from '@ontrails/core';
+
+const ROOT_DIR_MESSAGE =
+  'Trail execution requires rootDir input or ctx.cwd from the runtime context.';
+
+export const resolveTrailRootDir = (
+  rootDir: string | undefined,
+  cwd: string | undefined
+): Result<string, ValidationError> => {
+  const resolved = rootDir ?? cwd;
+  return resolved === undefined
+    ? Result.err(new ValidationError(ROOT_DIR_MESSAGE))
+    : Result.ok(resolved);
+};
+
+export const requireTrailRootDir = (rootDir: string | undefined): string => {
+  if (rootDir === undefined) {
+    throw new ValidationError(ROOT_DIR_MESSAGE);
+  }
+  return rootDir;
+};