feat(version): Add --include-merged-tags option (#1712)

commands/changed/README.md

@@ -26,4 +26,9 @@ package-2
 
 Unlike `lerna ls`, however, `lerna changed` **does not** support [filter options](https://www.npmjs.com/package/@lerna/filter-options), as filtering is not supported by `lerna version` or `lerna publish`.
 
-`lerna changed` also supports all the flags supported by [`lerna version`](https://github.com/lerna/lerna/tree/master/commands/version#options), but the only relevant one is [`--ignore-changes`](https://github.com/lerna/lerna/tree/master/commands/version#--ignore-changes).
+`lerna changed` also supports all the flags supported by [`lerna version`](https://github.com/lerna/lerna/tree/master/commands/version#options).
+
+Relevant ones are maybe:
+
+- [`--ignore-changes`](https://github.com/lerna/lerna/tree/master/commands/version#--ignore-changes).
+- [`--include-merged-tags`](https://github.com/lerna/lerna/tree/master/commands/version#--include-merged-tags).

commands/version/README.md

@@ -52,6 +52,7 @@ If you have any packages with a prerelease version number (e.g. `2.0.0-beta.3`)
 * [`--sign-git-commit`](#--sign-git-commit)
 * [`--sign-git-tag`](#--sign-git-tag)
 * [`--yes`](#--yes)
+* [`--include-merged-tags`](#--include-merged-tags)
 
 ### `--allow-branch <glob>`
 
@@ -273,6 +274,15 @@ lerna version --yes
 When run with this flag, `lerna version` will skip all confirmation prompts.
 Useful in [Continuous integration (CI)](https://en.wikipedia.org/wiki/Continuous_integration) to automatically answer the publish confirmation prompt.
 
+### `--include-merged-tags`
+
+```sh
+lerna version --include-merged-tags
+```
+
+When run with this flag, `lerna version` will also consider tags of merged branches
+while fetching changes for packages to update.
+
 ## Deprecated Options
 
 ### `--cd-version`

commands/version/__tests__/__fixtures__/basic/lerna.json

@@ -0,0 +1,3 @@
+{
+  "version": "1.0.0"
+}

commands/version/__tests__/__fixtures__/basic/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "independent"
+}

commands/version/__tests__/__fixtures__/basic/packages/package-1/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "package-1",
+  "version": "1.0.0"
+}

commands/version/__tests__/__fixtures__/basic/packages/package-2/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "package-2",
+  "version": "1.0.0",
+  "dependencies": {
+    "package-1": "^1.0.0"
+  }
+}

commands/version/__tests__/__fixtures__/basic/packages/package-3/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "package-3",
+  "version": "1.0.0",
+  "devDependencies": {
+    "package-2": "^1.0.0"
+  }
+}

commands/version/__tests__/__fixtures__/basic/packages/package-4/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "package-4",
+  "version": "1.0.0",
+  "dependencies": {
+    "package-1": "^0.0.0"
+  }
+}

commands/version/__tests__/__fixtures__/basic/packages/package-5/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "package-5",
+  "version": "1.0.0",
+  "private": true,
+  "dependencies": {
+    "package-1": "^1.0.0"
+  }
+}

commands/version/__tests__/version-command.test.js

@@ -599,4 +599,17 @@ describe("VersionCommand", () => {
       });
     });
   });
+
+  describe("--include-merged-tags", () => {
+    it("accepts --include-merged-tags", async () => {
+      const testDir = await initFixture("normal");
+      await lernaVersion(testDir)("--include-merged-tags", "--yes", "patch");
+
+      expect(PromptUtilities.select).not.toBeCalled();
+      expect(PromptUtilities.confirm).not.toBeCalled();
+
+      const message = await getCommitMessage(testDir);
+      expect(message).toBe("v1.0.1");
+    });
+  });
 });

commands/version/__tests__/version-include-merged-tags.test.js

@@ -0,0 +1,106 @@
+"use strict";
+
+// we're actually testing integration with git
+jest.unmock("@lerna/collect-updates");
+
+const path = require("path");
+const fs = require("fs");
+
+// mocked modules
+const output = require("@lerna/output");
+
+// helpers
+const initFixture = require("@lerna-test/init-fixture")(__dirname);
+const gitAdd = require("@lerna-test/git-add");
+const gitCommit = require("@lerna-test/git-commit");
+const gitTag = require("@lerna-test/git-tag");
+const gitCheckout = require("@lerna-test/git-checkout");
+const gitMerge = require("@lerna-test/git-merge");
+
+// file under test
+const lernaVersion = require("@lerna-test/command-runner")(require("../command"));
+
+// remove quotes around top-level strings
+expect.addSnapshotSerializer({
+  test(val) {
+    return typeof val === "string";
+  },
+  serialize(val, config, indentation, depth) {
+    // top-level strings don't need quotes, but nested ones do (object properties, etc)
+    return depth ? `"${val}"` : val;
+  },
+});
+
+// normalize temp directory paths in snapshots
+expect.addSnapshotSerializer(require("@lerna-test/serialize-windows-paths"));
+expect.addSnapshotSerializer(require("@lerna-test/serialize-tempdir"));
+
+describe("version --include-merged-tags", () => {
+  const setupGitChangesWithBranch = async (cwd, masterPaths, branchPaths) => {
+    await gitTag(cwd, "v1.0.0");
+    await Promise.all(masterPaths.map(fp => fs.appendFileSync(path.join(cwd, fp), "1")));
+    await gitAdd(cwd, "-A");
+    await gitCommit(cwd, "Commit");
+    // Create release branch
+    await gitCheckout(cwd, ["-b", "release/v1.0.1"]);
+    // Switch into release branch
+    await Promise.all(branchPaths.map(fp => fs.appendFileSync(path.join(cwd, fp), "1")));
+    await gitAdd(cwd, "-A");
+    await gitCommit(cwd, "Bump");
+    await gitTag(cwd, "v1.0.1");
+    await gitCheckout(cwd, ["master"]);
+    await gitMerge(cwd, ["--no-ff", "release/v1.0.1"]);
+    // Commit after merge
+    await Promise.all(masterPaths.map(fp => fs.appendFileSync(path.join(cwd, fp), "1")));
+    await gitAdd(cwd, "-A");
+    await gitCommit(cwd, "Commit2");
+  };
+
+  describe("disabled", () => {
+    it("should list changes to package-4", async () => {
+      const testDir = await initFixture("basic");
+
+      await setupGitChangesWithBranch(
+        testDir,
+        ["packages/package-2/random-file"],
+        ["packages/package-4/random-file"]
+      );
+      // Without --include-merged-tags we receive all changes since the last tag on master
+      // in this case it's v1.0.0, this includes changes to package-4 which was released
+      // in the release branch with v1.0.1
+      await lernaVersion(testDir)("--no-git-tag-version");
+
+      expect(output.logged()).toMatchInlineSnapshot(`
+
+Changes:
+ - package-2: 1.0.0 => 1.0.1
+ - package-3: 1.0.0 => 1.0.1
+ - package-4: 1.0.0 => 1.0.1
+
+`);
+    });
+  });
+
+  describe("enabled", () => {
+    it("should not list changes to package-4", async () => {
+      const testDir = await initFixture("basic");
+
+      await setupGitChangesWithBranch(
+        testDir,
+        ["packages/package-2/random-file"],
+        ["packages/package-4/random-file"]
+      );
+      // With --include-merged-tags we correctly detect that v1.0.1 was already tagged
+      // and merged. We no longer want to receive package-4.
+      await lernaVersion(testDir)("--no-git-tag-version", "--include-merged-tags");
+
+      expect(output.logged()).toMatchInlineSnapshot(`
+
+Changes:
+ - package-2: 1.0.0 => 1.0.1
+ - package-3: 1.0.0 => 1.0.1
+
+`);
+    });
+  });
+});

commands/version/command.js

@@ -84,6 +84,11 @@ exports.builder = (yargs, composed) => {
       requiresArg: true,
       defaultDescription: "v",
     },
+    "include-merged-tags": {
+      describe: "Also include tags from merged branches",
+      type: "boolean",
+      defaultDescription: "false",
+    },
     y: {
       describe: "Skip all confirmation prompts.",
       alias: "yes",

helpers/git-checkout/index.js

@@ -0,0 +1,9 @@
+"use strict";
+
+const execa = require("execa");
+
+module.exports = gitCheckout;
+
+function gitCheckout(cwd, args) {
+  return execa("git", ["checkout", ...args], { cwd });
+}

helpers/git-checkout/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@lerna-test/git-checkout",
+  "version": "0.0.0-test-only",
+  "description": "A local test helper",
+  "main": "index.js",
+  "private": true,
+  "license": "MIT",
+  "dependencies": {
+    "execa": "^1.0.0"
+  }
+}

helpers/git-merge/index.js

@@ -0,0 +1,9 @@
+"use strict";
+
+const execa = require("execa");
+
+module.exports = gitMerge;
+
+function gitMerge(cwd, args) {
+  return execa("git", ["merge", ...args], { cwd });
+}

helpers/git-merge/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@lerna-test/git-merge",
+  "version": "0.0.0-test-only",
+  "description": "A local test helper",
+  "main": "index.js",
+  "private": true,
+  "license": "MIT",
+  "dependencies": {
+    "execa": "^1.0.0"
+  }
+}

package.json

@@ -33,8 +33,10 @@
     "@lerna-test/find-fixture": "file:helpers/find-fixture",
     "@lerna-test/get-commit-message": "file:helpers/get-commit-message",
     "@lerna-test/git-add": "file:helpers/git-add",
+    "@lerna-test/git-checkout": "file:helpers/git-checkout",
     "@lerna-test/git-commit": "file:helpers/git-commit",
     "@lerna-test/git-init": "file:helpers/git-init",
+    "@lerna-test/git-merge": "file:helpers/git-merge",
     "@lerna-test/git-status": "file:helpers/git-status",
     "@lerna-test/git-tag": "file:helpers/git-tag",
     "@lerna-test/init-fixture": "file:helpers/init-fixture",

utils/collect-updates/collect-updates.js

@@ -21,7 +21,7 @@ function collectUpdates(filteredPackages, packageGraph, execOpts, commandOptions
 
   if (hasTags(execOpts)) {
     // describe the last annotated tag in the current branch
-    const { sha, refCount, lastTagName } = describeRef.sync(execOpts);
+    const { sha, refCount, lastTagName } = describeRef.sync(execOpts, commandOptions);
     // TODO: warn about dirty tree?
 
     if (refCount === "0" && forced.size === 0) {

utils/describe-ref/__tests__/describe-ref.test.js

@@ -41,6 +41,15 @@ describe("describeRef()", () => {
       options
     );
   });
+
+  it("accepts commandOptions.include-merged-tags", async () => {
+    const commandOptions = { "include-merged-tags": true, includeMergedTags: true };
+    await describeRef({}, commandOptions);
+
+    const newArgs = [...DEFAULT_ARGS];
+    newArgs.pop();
+    expect(childProcess.exec).toHaveBeenLastCalledWith("git", newArgs, {});
+  });
 });
 
 describe("describeRef.sync()", () => {

utils/describe-ref/lib/describe-ref.js

@@ -7,8 +7,8 @@ module.exports = describeRef;
 module.exports.parse = parse;
 module.exports.sync = sync;
 
-function getArgs(options) {
-  const args = [
+function getArgs(options, commandOptions = {}) {
+  let args = [
     "describe",
     // fallback to short sha if no tags located
     "--always",
@@ -24,11 +24,16 @@ function getArgs(options) {
     args.push("--match", options.match);
   }
 
+  if (commandOptions.includeMergedTags) {
+    // we want to consider all tags, also from merged branches
+    args = args.filter(arg => arg !== "--first-parent");
+  }
+
   return args;
 }
 
-function describeRef(options = {}) {
-  const promise = childProcess.exec("git", getArgs(options), options);
+function describeRef(options = {}, commandOptions = {}) {
+  const promise = childProcess.exec("git", getArgs(options, commandOptions), options);
 
   return promise.then(({ stdout }) => {
     const result = parse(stdout, options);
@@ -40,8 +45,8 @@ function describeRef(options = {}) {
   });
 }
 
-function sync(options = {}) {
-  const stdout = childProcess.execSync("git", getArgs(options), options);
+function sync(options = {}, commandOptions = {}) {
+  const stdout = childProcess.execSync("git", getArgs(options, commandOptions), options);
   const result = parse(stdout, options);
 
   // only called by collect-updates with no matcher