node-publisher 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+### v3.2.1 (2025-07-11)
+
+#### Pull requests
+
+- [#62](https://github.com/zendesk/node-publisher/pull/62) Fix yarn v2+ versioning ([Daria Radu](mailto:daria.radu@zendesk.com))
+
+#### Commits to master
+
+- [v3.2.1](https://github.com/zendesk/node-publisher/commit/1f0f25c7aec1e507d7a9c4fab6252ce00588e073) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [Update changelog](https://github.com/zendesk/node-publisher/commit/b444d894d713c2f4572b6b5211c09d8ff77cedac) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+
+### v3.2.0 (2025-07-10)
+
+#### Pull requests
+
+- [#61](https://github.com/zendesk/node-publisher/pull/61) Update node version ([Daria Radu](mailto:daria.radu@zendesk.com), [Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [#60](https://github.com/zendesk/node-publisher/pull/60) Run different publish command based on yarn version ([Daria Radu](mailto:daria.radu@zendesk.com))
+- [#59](https://github.com/zendesk/node-publisher/pull/59) Fix custom release branch setup to the correct parameter ([Daria Radu](mailto:daria.radu@zendesk.com))
+
+#### Commits to master
+
+- [v3.2.0](https://github.com/zendesk/node-publisher/commit/989ecec13e467b13217ff482f422bafe61e61dbf) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [Update changelog](https://github.com/zendesk/node-publisher/commit/e19ff455cae89cbd2796c00699ca4debaded6fac) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+
 ### v3.1.0 (2024-01-24)
 
 #### Pull requests

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-publisher",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "A configurable release automation tool inspired by create-react-app and Travis CI.",
   "author": "Attila Večerek <avecerek@zendesk.com>",
   "homepage": "https://github.com/zendesk/node-publisher#readme",

package/src/client/yarn-berry.js

@@ -0,0 +1,25 @@
+const { packageJson } = require('../utils/package');
+
+const version = str => {
+  if (str[0] === 'v') {
+    return str;
+  }
+
+  return `v${str}`;
+};
+
+const publish = ({ nextVersion, execCommand, env }) => {
+  execCommand(`yarn version ${nextVersion}`);
+
+  const pkg = packageJson();
+
+  execCommand(`git add package.json yarn.lock`);
+  execCommand(`git commit -m "${version(pkg.version)}"`);
+  execCommand(`git tag "${version(pkg.version)}"`);
+  execCommand(`git push origin ${env.branch || 'master'} --follow-tags`);
+  execCommand(`yarn npm publish`);
+};
+
+module.exports = {
+  publish
+};

package/src/client/yarn-berry.spec.js

@@ -0,0 +1,104 @@
+const { publish } = require('./yarn-berry');
+const { packageJson } = require('../utils/package');
+
+jest.mock('../utils/package');
+
+describe('publish', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('without preid', () => {
+    const options = {
+      nextVersion: 'patch',
+      preid: undefined,
+      env: { branch: 'main' },
+      execCommand: jest.fn()
+    };
+
+    beforeEach(() => {
+      packageJson.mockReturnValue({ version: '1.0.1' });
+    });
+
+    it('publishes new version using yarn v2+ syntax', () => {
+      expect(() => publish(options)).not.toThrow();
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        1,
+        'yarn version patch'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        2,
+        'git add package.json yarn.lock'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        3,
+        'git commit -m "v1.0.1"'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        4,
+        'git tag "v1.0.1"'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        5,
+        'git push origin main --follow-tags'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        6,
+        'yarn npm publish'
+      );
+    });
+  });
+
+  describe('with preid', () => {
+    const options = {
+      nextVersion: 'major',
+      preid: 'alpha',
+      env: { main: 'master' },
+      execCommand: jest.fn()
+    };
+
+    beforeEach(() => {
+      packageJson.mockReturnValue({ version: '2.0.0-alpha.0' });
+    });
+
+    it('publishes new version using yarn v2+ syntax', () => {
+      expect(() => publish(options)).not.toThrow();
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        1,
+        'yarn version major'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        2,
+        'git add package.json yarn.lock'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        3,
+        'git commit -m "v2.0.0-alpha.0"'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        4,
+        'git tag "v2.0.0-alpha.0"'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        5,
+        'git push origin master --follow-tags'
+      );
+
+      expect(options.execCommand).toHaveBeenNthCalledWith(
+        6,
+        'yarn npm publish'
+      );
+    });
+  });
+});

package/src/client/yarn.js

@@ -1,27 +1,5 @@
-const { execSync } = require('child_process');
-
-const getYarnVersion = () => {
-  try {
-    const output = execSync('yarn --version', { encoding: 'utf8' });
-    return output.trim();
-  } catch (error) {
-    // Default to yarn v1 if version detection fails
-    return '1.0.0';
-  }
-};
-
-const isYarnV2OrHigher = () => {
-  const version = getYarnVersion();
-  const majorVersion = parseInt(version.split('.')[0], 10);
-  return majorVersion >= 2;
-};
-
 const publish = ({ nextVersion, execCommand }) => {
-  if (isYarnV2OrHigher()) {
-    execCommand(`yarn npm publish --tag ${nextVersion}`);
-  } else {
-    execCommand(`yarn publish --new-version ${nextVersion}`);
-  }
+  execCommand(`yarn publish --new-version ${nextVersion}`);
 };
 
 module.exports = {

package/src/client/yarn.spec.js

@@ -47,61 +47,4 @@ describe('publish', () => {
       });
     });
   });
-
-  describe('with yarn v2+', () => {
-    beforeEach(() => {
-      execSync.mockReturnValue('4.1.0');
-    });
-
-    describe('without preid', () => {
-      const options = {
-        nextVersion: 'patch',
-        preid: undefined,
-        execCommand: jest.fn()
-      };
-
-      it('publishes new version using yarn v2+ syntax', () => {
-        expect(() => publish(options)).not.toThrow();
-        expect(options.execCommand.mock.calls[0][0]).toBe(
-          'yarn npm publish --tag patch'
-        );
-      });
-    });
-
-    describe('with preid', () => {
-      const options = {
-        nextVersion: 'major',
-        preid: 'alpha',
-        execCommand: jest.fn()
-      };
-
-      it('publishes new version using yarn v2+ syntax', () => {
-        expect(() => publish(options)).not.toThrow();
-        expect(options.execCommand.mock.calls[0][0]).toBe(
-          'yarn npm publish --tag major'
-        );
-      });
-    });
-  });
-
-  describe('when yarn version detection fails', () => {
-    beforeEach(() => {
-      execSync.mockImplementation(() => {
-        throw new Error('Command failed');
-      });
-    });
-
-    const options = {
-      nextVersion: 'patch',
-      preid: undefined,
-      execCommand: jest.fn()
-    };
-
-    it('defaults to yarn v1 syntax', () => {
-      expect(() => publish(options)).not.toThrow();
-      expect(options.execCommand.mock.calls[0][0]).toBe(
-        'yarn publish --new-version patch'
-      );
-    });
-  });
 });

package/src/utils/client/index.js

@@ -1,6 +1,7 @@
 const fs = require('fs');
 const path = require('path');
 const { LERNA_JSON_PATH } = require('../constants');
+const { isYarnBerry } = require('../yarn');
 
 const npmClient = () => {
   const clientMap = {
@@ -15,6 +16,10 @@ const npmClient = () => {
     }
   }
 
+  if (client === 'yarn' && isYarnBerry()) {
+    client = 'yarn-berry';
+  }
+
   if (!client) {
     throw new Error(
       'Client could not be detected, make sure you use one of the supported clients.'

package/src/utils/client/index.spec.js

@@ -1,10 +1,15 @@
 const { npmClient, publishClient } = require('./');
+const { isYarnBerry } = require('../yarn');
 
 jest.mock('fs');
 
+jest.mock('../yarn');
+
 describe('npmClient', () => {
   beforeEach(() => {
     require('fs').__setMockFiles([]);
+
+    isYarnBerry.mockImplementation(() => false);
   });
 
   describe('when client cannot be detected', () => {
@@ -28,6 +33,32 @@ describe('npmClient', () => {
     });
   });
 
+  describe('when yarn.lock found', () => {
+    const MOCKED_FILES = ['yarn.lock'];
+
+    describe('and yarn version is 1', () => {
+      it('returns yarn', () => {
+        require('fs').__setMockFiles(MOCKED_FILES);
+
+        expect(npmClient).not.toThrow();
+        expect(npmClient()).toBe('yarn');
+      });
+    });
+
+    describe('and yarn version is 4', () => {
+      beforeEach(() => {
+        isYarnBerry.mockImplementation(() => true);
+      });
+
+      it('returns yarn berry', () => {
+        require('fs').__setMockFiles(MOCKED_FILES);
+
+        expect(npmClient).not.toThrow();
+        expect(npmClient()).toBe('yarn-berry');
+      });
+    });
+  });
+
   describe('when both package-lock.json and yarn.lock are found', () => {
     const MOCKED_FILES = ['package-lock.json', 'yarn.lock'];
 

package/src/utils/config/index.js

@@ -3,9 +3,11 @@ const yaml = require('js-yaml');
 const readReleaseConfig = str => yaml.safeLoad(str);
 
 const buildReleaseConfig = env => {
-  const client = env.npmClient;
+  const client = env.npmClient === 'yarn-berry' ? 'yarn' : env.npmClient;
   const binPathPrefix = './node_modules/.bin/';
-  const scriptRunner = client === 'yarn' ? 'yarn' : 'npm run';
+  const scriptRunner = ['yarn', 'yarn-berry'].includes(client)
+    ? 'yarn'
+    : 'npm run';
 
   const config = {
     rollback: true,

package/src/utils/package/index.js

@@ -1,19 +1,14 @@
 const fs = require('fs');
 const { PACKAGE_JSON_PATH } = require('../constants');
 
-let pkg;
 const packageJson = () => {
-  if (pkg) return pkg;
-
   try {
-    pkg = JSON.parse(fs.readFileSync(PACKAGE_JSON_PATH, 'utf8'));
+    return JSON.parse(fs.readFileSync(PACKAGE_JSON_PATH, 'utf8'));
   } catch (e) {
     throw new Error(
       'Your package.json could not be parsed. Make sure the manifest is valid.'
     );
   }
-
-  return pkg;
 };
 
 module.exports = {

package/src/utils/yarn/index.js

@@ -0,0 +1,22 @@
+const { execSync } = require('child_process');
+
+const getYarnVersion = () => {
+  try {
+    const output = execSync('yarn --version', { encoding: 'utf8' });
+    return output.trim();
+  } catch (error) {
+    // Default to yarn v1 if version detection fails
+    return '1.0.0';
+  }
+};
+
+const isYarnBerry = () => {
+  const version = getYarnVersion();
+  const majorVersion = parseInt(version.split('.')[0], 10);
+  return majorVersion >= 2;
+};
+
+module.exports = {
+  getYarnVersion,
+  isYarnBerry
+};