Merge pull request #1397 from intuit/private-single-npm

skip publish for private npm packages

Author: hipstersmoothie

plugins/npm/__tests__/npm-next.test.ts

@@ -111,6 +111,49 @@ describe("next", () => {
     ]);
   });
 
+  test("skips publish for private package", async () => {
+    const plugin = new NPMPlugin();
+    const hooks = makeHooks();
+
+    plugin.apply(({
+      config: { prereleaseBranches: ["next"] },
+      hooks,
+      remote: "origin",
+      baseBranch: "master",
+      logger: dummyLog(),
+      getCurrentVersion: () => "1.2.3",
+      prefixRelease: (v: string) => v,
+      git: {
+        getLatestRelease: () => "1.0.0",
+        getLastTagNotInBaseBranch: () => "1.2.3",
+      },
+    } as unknown) as Auto.Auto);
+
+    readResult = `
+      {
+        "name": "test",
+        "version": "1.2.4-next.0",
+        "private": true
+      }
+    `;
+
+    expect(
+      await hooks.next.promise([], Auto.SEMVER.patch, {} as any)
+    ).toStrictEqual(["1.2.4-next.0"]);
+
+    expect(execPromise).toHaveBeenCalledWith("git", [
+      "push",
+      "origin",
+      "next",
+      "--tags",
+    ]);
+    expect(execPromise).not.toHaveBeenCalledWith("npm", [
+      "publish",
+      "--tag",
+      "next",
+    ]);
+  });
+
   test("works with legacy auth", async () => {
     process.env.NPM_TOKEN = "abcd";
     const plugin = new NPMPlugin({ legacyAuth: true });

plugins/npm/__tests__/npm.test.ts

@@ -811,7 +811,14 @@ describe("publish", () => {
     `;
 
     await hooks.publish.promise(Auto.SEMVER.patch);
-    expect(execPromise).toHaveBeenCalledWith("npm", ["publish"]);
+    expect(execPromise).not.toHaveBeenCalledWith("npm", ["publish"]);
+    expect(execPromise).toHaveBeenCalledWith("git", [
+      "push",
+      "--follow-tags",
+      "--set-upstream",
+      "origin",
+      "master",
+    ]);
   });
 });
 
@@ -848,6 +855,37 @@ describe("canary", () => {
     expect(execPromise.mock.calls[1][1]).toContain("1.2.4-canary.123.1.0");
   });
 
+  test("doesn't publish private packages", async () => {
+    const plugin = new NPMPlugin();
+    const hooks = makeHooks();
+
+    plugin.apply(({
+      config: { prereleaseBranches: ["next"] },
+      hooks,
+      remote: "origin",
+      baseBranch: "master",
+      logger: dummyLog(),
+      getCurrentVersion: () => "1.2.3",
+      git: {
+        getLatestRelease: () => "1.2.3",
+        getLatestTagInBranch: () => Promise.resolve("1.2.3"),
+      },
+    } as unknown) as Auto.Auto);
+
+    readResult = `
+      {
+        "name": "test",
+        "private": true
+      }
+    `;
+
+    expect(
+      await hooks.canary.promise(Auto.SEMVER.patch, "canary.123.1")
+    ).toStrictEqual({
+      error: "Package private, cannot make canary release to npm.",
+    });
+  });
+
   test("finds available canary version", async () => {
     const plugin = new NPMPlugin();
     const hooks = makeHooks();

plugins/npm/__tests__/set-npm-token.test.ts

@@ -7,6 +7,7 @@ import * as utils from "../src/utils";
 const loadPackageJson = utils.loadPackageJson as jest.Mock;
 const readFile = utils.readFile as jest.Mock;
 const writeFile = utils.writeFile as jest.Mock;
+const isMonorepo = utils.isMonorepo as jest.Mock;
 
 jest.mock("../src/utils.ts");
 jest.mock("env-ci", () => () => ({
@@ -31,6 +32,23 @@ describe("set npm token", () => {
     );
   });
 
+  test("should not write a new npmrc for single private package", async () => {
+    loadPackageJson.mockReturnValueOnce({ name: "test", private: true });
+    isMonorepo.mockReturnValueOnce(false);
+
+    await setNpmToken(dummyLog());
+    expect(writeFile).not.toHaveBeenCalled()
+  });
+
+
+  test("should write a npmrc for monorepo", async () => {
+    loadPackageJson.mockReturnValueOnce({ name: "test", private: true });
+    isMonorepo.mockReturnValueOnce(true);
+
+    await setNpmToken(dummyLog());
+    expect(writeFile).toHaveBeenCalled()
+  });
+
   test("should write a new npmrc w/o name", async () => {
     loadPackageJson.mockReturnValueOnce({});
     await setNpmToken(dummyLog());
@@ -52,7 +70,7 @@ describe("set npm token", () => {
     );
   });
 
-  test("should use registry for scoped pacakged", async () => {
+  test("should use registry for scoped packaged", async () => {
     loadPackageJson.mockReturnValueOnce({
       name: "@scope/test",
     });

plugins/npm/src/index.ts

@@ -26,14 +26,11 @@ import { gt, gte, inc, ReleaseType } from "semver";
 
 import getConfigFromPackageJson from "./package-config";
 import setTokenOnCI from "./set-npm-token";
-import { loadPackageJson, writeFile } from "./utils";
+import { loadPackageJson, writeFile, isMonorepo } from "./utils";
 
 const { isCi } = envCi();
 const VERSION_COMMIT_MESSAGE = '"Bump version to: %s [skip ci]"';
 
-/** Check if the project is a monorepo */
-const isMonorepo = () => fs.existsSync("lerna.json");
-
 /** Get the last published version for a npm package */
 async function getPublishedVersion(name: string) {
   try {
@@ -527,6 +524,12 @@ export default class NPMPlugin implements IPlugin {
         return;
       }
 
+      const { private: isPrivate } = await loadPackageJson();
+
+      if (isPrivate) {
+        return;
+      }
+
       auto.checkEnv(this.name, "NPM_TOKEN");
     });
 
@@ -810,7 +813,14 @@ export default class NPMPlugin implements IPlugin {
 
       auto.logger.verbose.info("Detected single npm package");
       const current = await auto.getCurrentVersion(lastRelease);
-      const { name } = await loadPackageJson();
+      const { name, private: isPrivate } = await loadPackageJson();
+
+      if (isPrivate) {
+        return {
+          error: "Package private, cannot make canary release to npm.",
+        };
+      }
+
       let canaryVersion = determineNextVersion(
         lastRelease,
         current,
@@ -941,21 +951,27 @@ export default class NPMPlugin implements IPlugin {
           ...verboseArgs,
         ]);
 
-        const { version } = await loadPackageJson();
+        const { version, private: isPrivate } = await loadPackageJson();
         await execPromise("git", [
           "tag",
           auto.prefixRelease(version!),
           "-m",
           `"Update version to ${version}"`,
         ]);
 
-        await execPromise("npm", [
-          "publish",
-          "--tag",
-          prereleaseBranch,
-          ...verboseArgs,
-          ...getLegacyAuthArgs(this.legacyAuth),
-        ]);
+        if (isPrivate) {
+          auto.logger.log.info(
+            `Package private, skipping prerelease publish to npm.`
+          );
+        } else {
+          await execPromise("npm", [
+            "publish",
+            "--tag",
+            prereleaseBranch,
+            ...verboseArgs,
+            ...getLegacyAuthArgs(this.legacyAuth),
+          ]);
+        }
 
         auto.logger.verbose.info("Successfully published next version");
         preReleaseVersions.push(auto.prefixRelease(version!));
@@ -1005,12 +1021,18 @@ export default class NPMPlugin implements IPlugin {
           ...getLegacyAuthArgs(this.legacyAuth, { isMonorepo: true }),
         ]);
       } else {
-        await execPromise("npm", [
-          "publish",
-          ...tag,
-          ...verboseArgs,
-          ...getLegacyAuthArgs(this.legacyAuth),
-        ]);
+        const { private: isPrivate } = await loadPackageJson();
+
+        if (isPrivate) {
+          auto.logger.log.info(`Package private, skipping publish to npm.`);
+        } else {
+          await execPromise("npm", [
+            "publish",
+            ...tag,
+            ...verboseArgs,
+            ...getLegacyAuthArgs(this.legacyAuth),
+          ]);
+        }
       }
 
       await execPromise("git", [

plugins/npm/src/set-npm-token.ts

@@ -5,7 +5,7 @@ import registryUrl from "registry-url";
 import urlJoin from "url-join";
 import userHome from "user-home";
 
-import { loadPackageJson, readFile, writeFile } from "./utils";
+import { loadPackageJson, readFile, writeFile, isMonorepo } from "./utils";
 
 const { isCi } = envCi();
 
@@ -15,7 +15,13 @@ export default async function setTokenOnCI(logger: ILogger) {
     return;
   }
 
-  const { publishConfig = {}, name } = await loadPackageJson();
+  const { publishConfig = {}, name, private: isPrivate } = await loadPackageJson();
+
+  if (isPrivate && !isMonorepo()) {
+    logger.verbose.info('NPM token not set for private package.')
+    return;
+  }
+
   const rc = path.join(userHome, ".npmrc");
   let contents = "";
 

plugins/npm/src/utils.ts

@@ -9,3 +9,6 @@ export const writeFile = promisify(fs.writeFile);
 export async function loadPackageJson(root = "./"): Promise<IPackageJSON> {
   return JSON.parse(await readFile(path.join(root, "package.json"), "utf-8"));
 }
+
+/** Check if the project is a monorepo */
+export const isMonorepo = () => fs.existsSync("lerna.json");