@docupace/pipeline 1.1.5 → 1.1.8

package/.changeset/validate-changeset-bin-fallback.md

@@ -0,0 +1,5 @@
+---
+'@docupace/pipeline': patch
+---
+
+Fix changeset validation failing with "No changeset found" on pull-request builds. Validation ran `./node_modules/.bin/changeset status` (since 1.1.6), but the validate step has no install, so the binary did not exist (exit 127). It now reads the release plan in-process with `@changesets/get-release-plan`, which needs neither the repo's `node_modules` nor a `changeset-output.json` file.

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @docupace/pipeline
 
+## 1.1.7
+
+### Patch Changes
+
+- 82e71f0: Run the changeset binary installed by the CLI directly instead of via `pnpm changeset`, so pnpm cannot re-sync node_modules to the repo lockfile and swap the changelog hook to an older pinned @docupace/pipeline.
+
+  Log the @docupace/pipeline version (to stderr) before every command of every dp-\*-cli, and log the CLI and changelog hook versions during changeset versioning.
+
 ## 1.1.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.1.5",
+  "version": "1.1.8",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -25,6 +25,7 @@
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "^3.600.0",
     "@changesets/cli": "2.27.12",
+    "@changesets/get-release-plan": "^4.0.16",
     "@docupace/core-client": "^1.0.1",
     "@jest/globals": "^30.1.2",
     "auth0-deploy-cli": "^8.8.0",

package/src/auth0/cli.js

@@ -19,10 +19,12 @@ import dotenv from 'dotenv';
 import { configureAlias } from './alias.js';
 import { exportConf } from './export.js';
 import { getAuth0Metadata } from './metadata.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 program
   .command(

package/src/changeset/cli.js

@@ -13,10 +13,12 @@ import {
 import { createChangeset } from './create.js';
 import { updateWikiWithVersion } from './changelog-wiki.js';
 import { convertPrepare, convertComplete } from './convert.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 const args = process.argv;
 

package/src/changeset/validate.js

@@ -5,7 +5,7 @@ import { $ } from 'zx';
 
 import { setGitInfo } from '../next/util.js';
 import { getPackageNames } from './package-util.js';
-import { versionStatus } from './version.js';
+import getReleasePlan from '@changesets/get-release-plan';
 
 const PACKAGE_ROOT = path.resolve(
   path.dirname(fileURLToPath(import.meta.url)),
@@ -16,6 +16,17 @@ const PACKAGE_VERSION = JSON.parse(
   fs.readFileSync(path.join(PACKAGE_ROOT, 'package.json'), 'utf8'),
 ).version;
 
+// Reads the release plan in-process with the changesets library instead of
+// running `changeset status`, so validation needs neither the repo's
+// node_modules (no install step runs before validate) nor an output file.
+export async function getValidationReleases(sinceBranch) {
+  const releasePlan = await getReleasePlan(process.cwd(), sinceBranch);
+  if (releasePlan.changesets.length === 0) {
+    throw new Error(`No changesets found since ${sinceBranch}`);
+  }
+  return releasePlan.releases;
+}
+
 export async function validateChangesets() {
   console.log(
     `validateChangesets: @docupace/pipeline version = ${PACKAGE_VERSION}`,
@@ -32,7 +43,7 @@ export async function validateChangesets() {
 
   try {
     console.log('🔍 Validating changesets...');
-    releases = await versionStatus(destBranch);
+    releases = await getValidationReleases(destBranch);
   } catch (e) {
     console.error(
       '❌ No changeset found. Please add a changeset to this PR. Please see more information at https://docupacellc.atlassian.net/wiki/spaces/PM/pages/1350893571/Creating+changesets+for+Docupace+Next',

package/src/changeset/validate.test.js

@@ -0,0 +1,79 @@
+import { afterEach, beforeEach, describe, expect, test } from '@jest/globals';
+import { execFileSync } from 'child_process';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { getValidationReleases } from './validate.js';
+
+const git = (cwd, ...args) =>
+  execFileSync('git', args, { cwd, stdio: 'pipe' }).toString();
+
+// A real repo with no node_modules, like the pipeline's validate step.
+function makeRepo() {
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'validate-changeset-'));
+  git(dir, 'init', '-q', '-b', 'master');
+  git(dir, 'config', 'user.email', 't@example.com');
+  git(dir, 'config', 'user.name', 'test');
+  fs.writeFileSync(
+    path.join(dir, 'package.json'),
+    JSON.stringify({ name: 'sample', version: '1.0.0' }),
+  );
+  fs.mkdirSync(path.join(dir, '.changeset'));
+  fs.writeFileSync(
+    path.join(dir, '.changeset', 'config.json'),
+    JSON.stringify({
+      changelog: false,
+      baseBranch: 'master',
+      access: 'restricted',
+    }),
+  );
+  git(dir, 'add', '-A');
+  git(dir, 'commit', '-q', '-m', 'base');
+  git(dir, 'checkout', '-q', '-b', 'feature');
+  fs.writeFileSync(path.join(dir, 'file.txt'), 'change');
+  return dir;
+}
+
+describe('getValidationReleases', () => {
+  let dir;
+  let originalCwd;
+
+  beforeEach(() => {
+    originalCwd = process.cwd();
+    dir = makeRepo();
+    process.chdir(dir);
+  });
+
+  afterEach(() => {
+    process.chdir(originalCwd);
+    fs.rmSync(dir, { recursive: true, force: true });
+  });
+
+  test('returns the releases when the branch adds a changeset', async () => {
+    fs.writeFileSync(
+      path.join(dir, '.changeset', 'DC-1.md'),
+      "---\n'sample': patch\n---\n\nA change\n",
+    );
+    git(dir, 'add', '-A');
+    git(dir, 'commit', '-q', '-m', 'feature');
+
+    const releases = await getValidationReleases('master');
+
+    expect(releases).toEqual([
+      expect.objectContaining({
+        name: 'sample',
+        type: 'patch',
+        newVersion: '1.0.1',
+      }),
+    ]);
+  });
+
+  test('throws when the branch has no changeset', async () => {
+    git(dir, 'add', '-A');
+    git(dir, 'commit', '-q', '-m', 'feature');
+
+    await expect(getValidationReleases('master')).rejects.toThrow(
+      'No changesets found since master',
+    );
+  });
+});

package/src/changeset/version.js

@@ -5,14 +5,37 @@ import { updateComponentVersion } from '../next/jira.js';
 import { findJiraTicketId } from './util.js';
 import { revertBaseBranch, updateBaseBranch } from './changeset-config.js';
 import semver from 'semver';
-import { dirname, join } from 'path';
-import { fileURLToPath } from 'url';
-
-const getPackageVersion = () => {
-  const __dirname = dirname(fileURLToPath(import.meta.url));
-  const packageJsonPath = join(__dirname, '../../package.json');
-  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf8'));
-  return packageJson.version;
+import { join } from 'path';
+import { getPipelineVersion as getPackageVersion } from '../lib/pipeline-version.js';
+
+// Run the changeset binary installed by the temporary install below rather than
+// `pnpm changeset`. Going through pnpm lets it re-sync node_modules with the
+// repo's own lockfile before the command runs, which swaps the pinned
+// @docupace/pipeline (used by the changelog hook) for whatever version the repo
+// lockfile holds instead of the version of this CLI.
+const CHANGESET_BIN = './node_modules/.bin/changeset';
+
+// Version of @docupace/pipeline the changelog hook will be loaded from (the
+// copy in the current directory's node_modules, not the one running this CLI).
+const getInstalledPipelineVersion = () => {
+  try {
+    const pkgPath = join(
+      process.cwd(),
+      'node_modules',
+      '@docupace',
+      'pipeline',
+      'package.json',
+    );
+    return JSON.parse(readFileSync(pkgPath, 'utf8')).version;
+  } catch (error) {
+    return `unknown (${error.message})`;
+  }
+};
+
+const logPipelineVersions = (stage) => {
+  console.log(
+    `🔎 @docupace/pipeline ${stage}: running CLI ${getPackageVersion()}, changelog hook ${getInstalledPipelineVersion()}`,
+  );
 };
 
 const getChangeSetPackage = (installLatest = false) => `{
@@ -61,9 +84,9 @@ export async function versionStatus(sinceBranch) {
   const outputPath = './changeset-output.json';
 
   if (sinceBranch) {
-    await $`pnpm changeset status --output=${outputPath} --since=${sinceBranch}`;
+    await $`${CHANGESET_BIN} status --output=${outputPath} --since=${sinceBranch}`;
   } else {
-    await $`pnpm changeset status --output=${outputPath}`;
+    await $`${CHANGESET_BIN} status --output=${outputPath}`;
   }
 
   // Read the file and parse JSON
@@ -77,6 +100,7 @@ export async function versionCommand(
   installLatest = false,
 ) {
   console.log('📦 Running Changeset versioning...');
+  logPipelineVersions('at start');
   if (!process.env.IS_DEV) {
     await setGitInfo();
     await $`mv package.json package.json.bak`;
@@ -98,9 +122,10 @@ export async function versionCommand(
     }
     await $`mv package.json.bak package.json`;
     await $`mv pnpm-lock.yaml.bak pnpm-lock.yaml`;
+    logPipelineVersions('after install');
   }
   if (closeVersion) {
-    await $`pnpm changeset pre exit`;
+    await $`${CHANGESET_BIN} pre exit`;
   }
 
   let originalBaseBranch;
@@ -117,7 +142,8 @@ export async function versionCommand(
 
   // Intentionally outside the try/catch above: a failure here (e.g. release
   // notes processing) must fail the build, not be swallowed as "no releases".
-  await $`pnpm changeset version`;
+  logPipelineVersions('before changeset version');
+  await $`${CHANGESET_BIN} version`;
 
   await removeChangesetOutput();
 

package/src/lib/pipeline-version.js

@@ -0,0 +1,25 @@
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+
+/**
+ * Version of the @docupace/pipeline package this code is running from.
+ */
+export function getPipelineVersion() {
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const packageJsonPath = join(__dirname, '../../package.json');
+  return JSON.parse(readFileSync(packageJsonPath, 'utf8')).version;
+}
+
+/**
+ * Registers a commander hook that logs the @docupace/pipeline version before
+ * any command of the given program runs. Written to stderr so it never mixes
+ * with output that callers parse from stdout.
+ */
+export function logVersionBeforeCommands(program) {
+  program.hook('preAction', (_thisCommand, actionCommand) => {
+    console.error(
+      `🔎 @docupace/pipeline ${getPipelineVersion()} (${program.name() || 'cli'} ${actionCommand.name()})`,
+    );
+  });
+}

package/src/merge/cli.js

@@ -6,9 +6,11 @@ import { Command } from 'commander';
 import { setupMerge } from './cli-merge.js';
 import { setupResolve } from './cli-resolve.js';
 import { setupMergeAll } from './cli-merge-all.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 const args = process.argv;
 const program = new Command();
+logVersionBeforeCommands(program);
 
 /**
  * Reusable auto-resolve function

package/src/micro/cli.js

@@ -9,10 +9,12 @@ import {
   microserviceCopyImageToEnv,
   microserviceBuildPushImage,
 } from './ms-deploy.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 //const GIT_SHA = (await $`git log --pretty=format:'%h' -n 1`).stdout.trim();
 

package/src/next/cli.js

@@ -23,10 +23,12 @@ import { deployConnect, deployCore } from './jenkins.js';
 import { deployConnectAws, runPipelineChecked } from './connect-aws.js';
 import { registerConnectAwsCommands } from './connect-aws-cli.js';
 import { runPipeline } from './pipline.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 const GIT_SHA = (await $`git log --pretty=format:'%h' -n 1`).stdout.trim();
 

package/src/tenable/cli.js

@@ -3,8 +3,10 @@
 import { Command } from 'commander';
 import { $ } from 'zx';
 import { runTenableScan } from './scan.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 program
   .command('scan')

package/src/veracode/cli.js

@@ -2,8 +2,10 @@
 
 import { Command } from 'commander';
 import { runVeracodeScan } from './scan.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 program
   .command('scan')

package/src/xray/cli.js

@@ -2,8 +2,10 @@
 
 import { Command } from 'commander';
 import { notify } from './notify.js';
+import { logVersionBeforeCommands } from '../lib/pipeline-version.js';
 
 const program = new Command();
+logVersionBeforeCommands(program);
 
 program
   .command('notify')