node-publisher 3.1.0 → 3.2.0

package/.eslintrc.json

@@ -2,7 +2,7 @@
   "env": {
     "browser": false,
     "es6": true,
-    "jest/globals": true,
+    "jest": true,
     "node": true
   },
   "extends": ["standard", "prettier", "prettier/standard"],
@@ -11,9 +11,7 @@
     "SharedArrayBuffer": "readonly"
   },
   "parser": "babel-eslint",
-  "plugins": [
-    "jest"
-  ],
+  "plugins": ["jest"],
   "rules": {
     "react/no-unused-prop-types": "off",
     "react/prop-types": "off",

package/.nvmrc

@@ -1 +1 @@
-v14.21.1
+v22.16.0

package/CHANGELOG.md

@@ -1,8 +1,20 @@
+### v3.1.0 (2024-01-24)
+
+#### Pull requests
+
+- [#55](https://github.com/zendesk/node-publisher/pull/55) Upgrade offline-github-changelog to fix duplicate authors ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [#54](https://github.com/zendesk/node-publisher/pull/54) Make local installs work with yarn v4 ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+
+#### Commits to master
+
+- [v3.1.0](https://github.com/zendesk/node-publisher/commit/5a1605e05a331211d8533533aba481aa724263ab) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [Update changelog](https://github.com/zendesk/node-publisher/commit/f06d6612e0a3fc350ba06b9925c42852e92c32c8) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
+
 ### v3.0.0 (2022-12-06)
 
 #### Pull requests
 
-- [#47](https://github.com/zendesk/node-publisher/pull/47) Upgrade offline-github-changelog \(Major\) ([Sune Simonsen](mailto:sune@we-knowhow.dk), [Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [#47](https://github.com/zendesk/node-publisher/pull/47) Upgrade offline-github-changelog \(Major\) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
 - [#46](https://github.com/zendesk/node-publisher/pull/46) Upgrade offline-github-changelog ([Sune Simonsen](mailto:sune@we-knowhow.dk))
 
 #### Commits to master
@@ -33,7 +45,7 @@
 
 #### Pull requests
 
-- [#45](https://github.com/zendesk/node-publisher/pull/45) Upgrade offline-github-changelog to the latest version \(Major\) ([Sune Simonsen](mailto:sune@we-knowhow.dk), [Sune Simonsen](mailto:sune@we-knowhow.dk), [Sune Simonsen](mailto:sune@we-knowhow.dk))
+- [#45](https://github.com/zendesk/node-publisher/pull/45) Upgrade offline-github-changelog to the latest version \(Major\) ([Sune Simonsen](mailto:sune@we-knowhow.dk))
 
 #### Commits to master
 
@@ -45,7 +57,7 @@
 #### Pull requests
 
 - [#44](https://github.com/zendesk/node-publisher/pull/44) Upgrade offline-github-changelog to the latest version ([Sune Simonsen](mailto:sune@we-knowhow.dk))
-- [#42](https://github.com/zendesk/node-publisher/pull/42) Add GitHub Actions workflows to migrate away from Travis-CI ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [John Shen](mailto:john@everops.com), [John Shen](mailto:john@everops.com))
+- [#42](https://github.com/zendesk/node-publisher/pull/42) Add GitHub Actions workflows to migrate away from Travis-CI ([Attila Večerek](mailto:avecerek@zendesk.com), [John Shen](mailto:john@everops.com))
 - [#43](https://github.com/zendesk/node-publisher/pull/43) Use node version from .nvmrc in GHA workflow ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
@@ -58,7 +70,7 @@
 #### Pull requests
 
 - [#41](https://github.com/zendesk/node-publisher/pull/41) Fix reading the contents of .nvmrc ([Attila Večerek](mailto:avecerek@zendesk.com))
-- [#40](https://github.com/zendesk/node-publisher/pull/40) Remove dependency on NVM ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#40](https://github.com/zendesk/node-publisher/pull/40) Remove dependency on NVM ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -71,11 +83,11 @@
 
 - [#37](https://github.com/zendesk/node-publisher/pull/37) Update jest ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#36](https://github.com/zendesk/node-publisher/pull/36) Update lint-staged ([Attila Večerek](mailto:avecerek@zendesk.com))
-- [#33](https://github.com/zendesk/node-publisher/pull/33) Update dependencies ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#33](https://github.com/zendesk/node-publisher/pull/33) Update dependencies ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#35](https://github.com/zendesk/node-publisher/pull/35) Fix the generated config for custom release branches ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#34](https://github.com/zendesk/node-publisher/pull/34) Order branches during the release branch selection setup process ([Attila Večerek](mailto:avecerek@zendesk.com))
-- [#32](https://github.com/zendesk/node-publisher/pull/32) Implement a setup script, take 2 ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
-- [#31](https://github.com/zendesk/node-publisher/pull/31) Address security alerts ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#32](https://github.com/zendesk/node-publisher/pull/32) Implement a setup script, take 2 ([Attila Večerek](mailto:avecerek@zendesk.com))
+- [#31](https://github.com/zendesk/node-publisher/pull/31) Address security alerts ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -87,7 +99,7 @@
 #### Pull requests
 
 - [#30](https://github.com/zendesk/node-publisher/pull/30) Fix the build step not committing the changes ([Attila Večerek](mailto:avecerek@zendesk.com))
-- [#28](https://github.com/zendesk/node-publisher/pull/28) Add --branch release param ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#28](https://github.com/zendesk/node-publisher/pull/28) Add --branch release param ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -98,7 +110,7 @@
 
 #### Pull requests
 
-- [#26](https://github.com/zendesk/node-publisher/pull/26) Support multiple release configurations ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#26](https://github.com/zendesk/node-publisher/pull/26) Support multiple release configurations ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -109,7 +121,7 @@
 
 #### Pull requests
 
-- [#27](https://github.com/zendesk/node-publisher/pull/27) Remove version constraints and add prerelease option ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#27](https://github.com/zendesk/node-publisher/pull/27) Remove version constraints and add prerelease option ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -120,7 +132,7 @@
 
 #### Pull requests
 
-- [#24](https://github.com/zendesk/node-publisher/pull/24) Add details to package.json + minor adjustments ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#24](https://github.com/zendesk/node-publisher/pull/24) Add details to package.json + minor adjustments ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#23](https://github.com/zendesk/node-publisher/pull/23) Fix small typo in readme ([Marc Høegh](mailto:Anifacted@users.noreply.github.com))
 
 #### Commits to master
@@ -134,8 +146,8 @@
 
 - [#22](https://github.com/zendesk/node-publisher/pull/22) Add publish config to be able to release with yarn again ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#21](https://github.com/zendesk/node-publisher/pull/21) Rename package and adds licenses field to package.json ([Attila Večerek](mailto:avecerek@zendesk.com))
-- [#20](https://github.com/zendesk/node-publisher/pull/20) Remove private repo configuration ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
-- [#18](https://github.com/zendesk/node-publisher/pull/18) Update README ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#20](https://github.com/zendesk/node-publisher/pull/20) Remove private repo configuration ([Attila Večerek](mailto:avecerek@zendesk.com))
+- [#18](https://github.com/zendesk/node-publisher/pull/18) Update README ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -180,7 +192,7 @@
 
 #### Pull requests
 
-- [#14](https://github.com/zendesk/node-publisher/pull/14) Add test runner whitelist ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#14](https://github.com/zendesk/node-publisher/pull/14) Add test runner whitelist ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master
 
@@ -273,7 +285,7 @@
 
 #### Pull requests
 
-- [#2](https://github.com/zendesk/node-publisher/pull/2) Fix rollback and own release ([Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com), [Attila Večerek](mailto:avecerek@zendesk.com))
+- [#2](https://github.com/zendesk/node-publisher/pull/2) Fix rollback and own release ([Attila Večerek](mailto:avecerek@zendesk.com))
 - [#1](https://github.com/zendesk/node-publisher/pull/1) Initial PR ([Attila Večerek](mailto:avecerek@zendesk.com))
 
 #### Commits to master

package/package.json

@@ -1,5 +1,6 @@
 {
   "name": "node-publisher",
+  "version": "3.2.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",
@@ -10,12 +11,11 @@
   "bugs": {
     "url": "https://github.com/zendesk/node-publisher/issues"
   },
-  "version": "3.1.0",
   "main": "src/index.js",
   "bin": "./bin/node-publisher",
   "scripts": {
     "coverage": "jest --coverage",
-    "lint": "eslint ./**/*.js",
+    "lint": "eslint src/**/*.js bin/**",
     "lint-staged": "lint-staged",
     "release": "./bin/node-publisher release",
     "test": "jest",
@@ -26,24 +26,24 @@
     "commander": "2.15.1",
     "inquirer": "6.5.0",
     "js-yaml": "3.13.1",
-    "offline-github-changelog": "3.0.2",
-    "semver": "6.2.0"
+    "offline-github-changelog": "3.1.0",
+    "semver": "7.7.2"
   },
   "devDependencies": {
-    "babel-eslint": "10.0.2",
+    "babel-eslint": "10.1.0",
     "eslint": "^6.0.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^14.0.0",
     "eslint-plugin-import": "^2.18.0",
-    "eslint-plugin-jest": "^22.0.0",
+    "eslint-plugin-jest": "^23.20.0",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.2.0",
     "eslint-plugin-standard": "^4.0.0",
-    "jest": "24.9.0",
+    "jest": "^27.0.0",
     "lint-staged": "^9.0.0",
     "pre-commit": "1.2.2",
     "prettier": "1.18.2",
-    "prettier-package-json": "2.0.1"
+    "prettier-package-json": "2.8.0"
   },
   "keywords": [
     "lerna",
@@ -52,7 +52,7 @@
     "yarn"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public",

package/src/client/yarn.js

@@ -1,5 +1,27 @@
+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 }) => {
-  execCommand(`yarn publish --new-version ${nextVersion}`);
+  if (isYarnV2OrHigher()) {
+    execCommand(`yarn npm publish --tag ${nextVersion}`);
+  } else {
+    execCommand(`yarn publish --new-version ${nextVersion}`);
+  }
 };
 
 module.exports = {

package/src/client/yarn.spec.js

@@ -1,32 +1,106 @@
 const { publish } = require('./yarn');
 
+// Mock execSync to control yarn version detection
+jest.mock('child_process', () => ({
+  execSync: jest.fn()
+}));
+
+const { execSync } = require('child_process');
+
 describe('publish', () => {
-  describe('without preid', () => {
-    const options = {
-      nextVersion: 'patch',
-      preid: undefined,
-      execCommand: jest.fn()
-    };
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
 
-    it('publishes new version without a prerelease id', () => {
-      expect(() => publish(options)).not.toThrow();
-      expect(options.execCommand.mock.calls[0][0]).toBe(
-        'yarn publish --new-version patch'
-      );
+  describe('with yarn v1', () => {
+    beforeEach(() => {
+      execSync.mockReturnValue('1.22.10');
+    });
+
+    describe('without preid', () => {
+      const options = {
+        nextVersion: 'patch',
+        preid: undefined,
+        execCommand: jest.fn()
+      };
+
+      it('publishes new version using yarn v1 syntax', () => {
+        expect(() => publish(options)).not.toThrow();
+        expect(options.execCommand.mock.calls[0][0]).toBe(
+          'yarn publish --new-version patch'
+        );
+      });
+    });
+
+    describe('with preid', () => {
+      const options = {
+        nextVersion: 'major',
+        preid: 'alpha',
+        execCommand: jest.fn()
+      };
+
+      it('publishes new version using yarn v1 syntax', () => {
+        expect(() => publish(options)).not.toThrow();
+        expect(options.execCommand.mock.calls[0][0]).toBe(
+          'yarn publish --new-version major'
+        );
+      });
+    });
+  });
+
+  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('with preid', () => {
+  describe('when yarn version detection fails', () => {
+    beforeEach(() => {
+      execSync.mockImplementation(() => {
+        throw new Error('Command failed');
+      });
+    });
+
     const options = {
-      nextVersion: 'major',
-      preid: 'alpha',
+      nextVersion: 'patch',
+      preid: undefined,
       execCommand: jest.fn()
     };
 
-    it('publishes new version without a prerelease id', () => {
+    it('defaults to yarn v1 syntax', () => {
       expect(() => publish(options)).not.toThrow();
       expect(options.execCommand.mock.calls[0][0]).toBe(
-        'yarn publish --new-version major'
+        'yarn publish --new-version patch'
       );
     });
   });

package/src/setup/release-branch/index.js

@@ -25,10 +25,8 @@ const gitBranches = () => {
 const prioritizeDefaultBranch = branches => {
   const index = branches.indexOf(DEFAULT_BRANCH);
 
-  return index === -1
-    ? branches
-    : branches.splice(index, 1).concat(branches);
-}
+  return index === -1 ? branches : branches.splice(index, 1).concat(branches);
+};
 
 const question = () => ({
   type: 'list',
@@ -49,7 +47,7 @@ async function releaseBranchStep() {
   const releaseCommand =
     releaseBranch === 'master'
       ? 'node-publisher release'
-      : `node-publisher release --default-branch=${releaseBranch}`;
+      : `node-publisher release --branch=${releaseBranch}`;
 
   addScript('release', releaseCommand);
 }

package/src/utils/index.js

@@ -1,22 +1,22 @@
-const path = require('path');
-const fs = require('fs');
-const command = require('./command');
+const path = require("path");
+const fs = require("fs");
+const command = require("./command");
 const {
   DEFAULT_CONFIG_PATH,
   DEFAULT_BRANCH,
   VALID_TEST_RUNNERS,
   DEFAULT_TEST_RUNNER
-} = require('./constants');
-const { npmClient, publishClient } = require('./client');
-const { readReleaseConfig, buildReleaseConfig } = require('./config');
-const { packageJson } = require('./package');
+} = require("./constants");
+const { npmClient, publishClient } = require("./client");
+const { readReleaseConfig, buildReleaseConfig } = require("./config");
+const { packageJson } = require("./package");
 const {
   validateNodeVersion,
   validatePkgRoot,
   validateTestRunner,
   validateLerna,
   hasBuildScript
-} = require('./validations');
+} = require("./validations");
 
 const buildReleaseEnvironment = ({
   branch = DEFAULT_BRANCH,
@@ -40,7 +40,7 @@ const buildReleaseEnvironment = ({
   }
 
   const client = publishClient();
-  if (client === 'lerna') {
+  if (client === "lerna") {
     validateLerna();
   }
 
@@ -60,7 +60,7 @@ const loadReleaseConfig = env => {
     : path.resolve(process.env.PWD, env.configPath);
 
   if (fs.existsSync(configPath)) {
-    return readReleaseConfig(fs.readFileSync(configPath, 'utf8'));
+    return readReleaseConfig(fs.readFileSync(configPath, "utf8"));
   } else if (env.configPath !== DEFAULT_CONFIG_PATH) {
     throw new Error(
       `The configuration file \`${env.configPath}\` does not exist.`
@@ -82,14 +82,14 @@ const execCommands = configCommands => {
 
 const currentCommitId = () =>
   command
-    .exec('git rev-parse HEAD', {})
+    .exec("git rev-parse HEAD", {})
     .toString()
     .trim();
 
 const rollbackCommit = commitId => command.exec(`git reset --hard ${commitId}`);
 
 const versionTransformer = (version, _answers, flags) =>
-  flags.isFinal && version[0] !== 'v' ? `v${version}` : version;
+  flags.isFinal && version[0] !== "v" ? `v${version}` : version;
 
 module.exports = {
   buildReleaseEnvironment,