Merge branch 'main' into phale/W-8857752

Author: peternhale

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.10.0](https://github.com/salesforcecli/plugin-release-management/compare/v1.9.4...v1.10.0) (2021-05-20)
+
+
+### Features
+
+* add npm:release:validate command ([#122](https://github.com/salesforcecli/plugin-release-management/issues/122)) ([418ca2e](https://github.com/salesforcecli/plugin-release-management/commit/418ca2ec3b9f2e9749448d8f9938bd390b52998c))
+
 ### [1.9.4](https://github.com/salesforcecli/plugin-release-management/compare/v1.9.3...v1.9.4) (2021-05-12)
 
 

README.md

@@ -99,6 +99,7 @@ sfdx plugins
 * [`sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmdependenciespin--d--t-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmlernarelease--d--s-array--t-string--a-string---install---githubrelease---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmpackagerelease--d--s--t-string--a-string---install---prerelease-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
+* [`sfdx npm:release:validate [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmreleasevalidate---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx `](#sfdx-)
 * [`sfdx trust:sign -s <string> -p <string> -k <string> [-t <string> | --tarpath <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-trustsign--s-string--p-string--k-string--t-string----tarpath-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
 * [`sfdx trust:upload -f <string> -b <string> [-k <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-trustupload--f-string--b-string--k-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
@@ -124,7 +125,7 @@ EXAMPLE
   sfdx circleci -t plugin
 ```
 
-_See code: [src/commands/circleci/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/circleci/index.ts)_
+_See code: [src/commands/circleci/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/circleci/index.ts)_
 
 ## `sfdx circleci:envvar:update -e <string> [-s <string>] [--dryrun] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -161,7 +162,7 @@ EXAMPLES
   sfdx circleci -t plugin | sfdx circleci:envvar:update -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'
 ```
 
-_See code: [src/commands/circleci/envvar/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/circleci/envvar/update.ts)_
+_See code: [src/commands/circleci/envvar/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/circleci/envvar/update.ts)_
 
 ## `sfdx cli:versions:inspect -c <string> -l <string> [-d <string>] [-s] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -206,7 +207,7 @@ EXAMPLES
   sfdx cli:versions:inspect -l npm -c latest -d chalk -s
 ```
 
-_See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/cli/versions/inspect.ts)_
+_See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/cli/versions/inspect.ts)_
 
 ## `sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -231,7 +232,7 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/npm/dependencies/pin.ts)_
+_See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/npm/dependencies/pin.ts)_
 
 ## `sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -266,7 +267,7 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/npm/lerna/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/npm/lerna/release.ts)_
+_See code: [src/commands/npm/lerna/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/npm/lerna/release.ts)_
 
 ## `sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -304,7 +305,28 @@ OPTIONS
                                                                                     is not manually set
 ```
 
-_See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/npm/package/release.ts)_
+_See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/npm/package/release.ts)_
+
+## `sfdx npm:release:validate [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+
+inspects the git commits to see if there are any commits that will warrant a new release
+
+```
+USAGE
+  $ sfdx npm:release:validate [--verbose] [--json] [--loglevel 
+  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+
+OPTIONS
+  --json                                                                            format output as json
+
+  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
+                                                                                    this command invocation
+
+  --verbose                                                                         show all commits for all packages
+                                                                                    (only works with --json flag)
+```
+
+_See code: [src/commands/npm/release/validate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/npm/release/validate.ts)_
 
 ## `sfdx `
 
@@ -349,7 +371,7 @@ EXAMPLES
   sfdx repositories --json | jq -r '.result[] | select(.name=="sfdx-core") | .packages[] | .url
 ```
 
-_See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/repositories/index.ts)_
+_See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/repositories/index.ts)_
 
 ## `sfdx trust:sign -s <string> -p <string> -k <string> [-t <string> | --tarpath <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -384,7 +406,7 @@ OPTIONS
       specify the package tgz path to sign instead of generating one from the target package
 ```
 
-_See code: [src/commands/trust/sign.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/trust/sign.ts)_
+_See code: [src/commands/trust/sign.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/trust/sign.ts)_
 
 ## `sfdx trust:upload -f <string> -b <string> [-k <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -409,7 +431,7 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/trust/upload.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/trust/upload.ts)_
+_See code: [src/commands/trust/upload.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/trust/upload.ts)_
 
 ## `sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
 
@@ -436,5 +458,5 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/typescript/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.3/src/commands/typescript/update.ts)_
+_See code: [src/commands/typescript/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v1.9.4/src/commands/typescript/update.ts)_
 <!-- commandsstop -->

command-snapshot.json

@@ -29,6 +29,11 @@
     "plugin": "@salesforce/plugin-release-management",
     "flags": ["dryrun", "install", "json", "loglevel", "npmaccess", "npmtag", "prerelease", "sign"]
   },
+  {
+    "command": "npm:release:validate",
+    "plugin": "@salesforce/plugin-release-management",
+    "flags": ["json", "loglevel", "verbose"]
+  },
   {
     "command": "repositories",
     "plugin": "@salesforce/plugin-release-management",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-release-management",
   "description": "A plugin for preparing and publishing npm packages",
-  "version": "1.9.4",
+  "version": "1.10.0",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "bin": {
@@ -126,6 +126,9 @@
           },
           "package": {
             "description": "work with npm projects"
+          },
+          "release": {
+            "description": "validate npm releases"
           }
         }
       },

src/commands/npm/release/validate.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { flags, FlagsConfig, SfdxCommand } from '@salesforce/command';
+import { isMonoRepo, LernaRepo } from '../../../repository';
+import { Package } from '../../../package';
+import { CommitInspection, inspectCommits } from '../../../inspectCommits';
+
+type PackageCommits = CommitInspection & {
+  name: string;
+  currentVersion: string;
+};
+
+type Response = {
+  shouldRelease: boolean;
+  packages?: PackageCommits[];
+};
+
+export default class Validate extends SfdxCommand {
+  public static readonly description =
+    'inspects the git commits to see if there are any commits that will warrant a new release';
+  public static readonly flagsConfig: FlagsConfig = {
+    verbose: flags.builtin({
+      description: 'show all commits for all packages (only works with --json flag)',
+    }),
+  };
+
+  public async run(): Promise<Response> {
+    const isLerna = await isMonoRepo();
+    const packages = isLerna ? await LernaRepo.getPackages() : [await Package.create()];
+    const responses: PackageCommits[] = [];
+    for (const pkg of packages) {
+      const commitInspection = await inspectCommits(pkg, isLerna);
+      const response = Object.assign(commitInspection, {
+        name: pkg.name,
+        currentVersion: pkg.packageJson.version,
+      });
+      responses.push(response);
+    }
+    const shouldRelease = responses.some((resp) => !!resp.shouldRelease);
+    this.ux.log(shouldRelease.toString());
+    return this.flags.verbose ? { shouldRelease, packages: responses } : { shouldRelease };
+  }
+}

src/commands/typescript/update.ts

@@ -63,7 +63,7 @@ export default class Update extends SfdxCommand {
   }
 
   private async getPackages(): Promise<Package[]> {
-    return this.repo instanceof LernaRepo ? await this.repo.getPackages() : [this.repo.package];
+    return this.repo instanceof LernaRepo ? await LernaRepo.getPackages() : [this.repo.package];
   }
 
   private async updateEsTargetConfig(packagePath: string): Promise<void> {

src/inspectCommits.ts

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2020, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as os from 'os';
+import { Readable } from 'stream';
+import { exec } from 'shelljs';
+import * as conventionalCommitsParser from 'conventional-commits-parser';
+import * as conventionalChangelogPresetLoader from 'conventional-changelog-preset-loader';
+import { Nullable } from '@salesforce/ts-types';
+import { Package } from './package';
+
+export interface Commit {
+  type: Nullable<string>;
+  header: Nullable<string>;
+  body: Nullable<string>;
+}
+
+export interface CommitInspection {
+  releasableCommits: Commit[];
+  unreleasableCommits: Commit[];
+  nextVersionIsHardcoded: boolean;
+  shouldRelease: boolean;
+}
+
+/**
+ * If the commit type isn't fix (patch bump), feat (minor bump), or breaking (major bump),
+ * then standard-version always defaults to a patch bump.
+ * See https://github.com/conventional-changelog/standard-version/issues/577
+ *
+ * We, however, don't want to publish a new version for chore, docs, etc. So we analyze
+ * the commits to see if any of them indicate that a new release should be published.
+ */
+export async function inspectCommits(pkg: Package, lerna = false): Promise<CommitInspection> {
+  const skippableCommitTypes = ['chore', 'style', 'docs', 'ci', 'test'];
+
+  // find the latest git tag so that we can get all the commits that have happened since
+  const tags = exec('git fetch --tags && git tag', { silent: true }).stdout.split(os.EOL);
+  const latestTag = lerna
+    ? tags.find((tag) => tag.includes(`${pkg.name}@${pkg.npmPackage.version}`)) || ''
+    : tags.find((tag) => tag.includes(pkg.npmPackage.version));
+  // import the default commit parser configuration
+  const defaultConfigPath = require.resolve('conventional-changelog-conventionalcommits');
+  const configuration = await conventionalChangelogPresetLoader({ name: defaultConfigPath });
+
+  const commits: Commit[] = await new Promise((resolve) => {
+    const DELIMITER = 'SPLIT';
+    const gitLogCommand = lerna
+      ? `git log --format=%B%n-hash-%n%H%n${DELIMITER} ${latestTag}..HEAD --no-merges -- ${pkg.location}`
+      : `git log --format=%B%n-hash-%n%H%n${DELIMITER} ${latestTag}..HEAD --no-merges`;
+    const gitLog = exec(gitLogCommand, { silent: true })
+      .stdout.split(`${DELIMITER}${os.EOL}`)
+      .filter((c) => !!c);
+    const readable = Readable.from(gitLog);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore because the type exported from conventionalCommitsParser is wrong
+    const parser = readable.pipe(conventionalCommitsParser(configuration.parserOpts));
+    const allCommits: Commit[] = [];
+    parser.on('data', (commit: Commit) => allCommits.push(commit));
+    parser.on('finish', () => resolve(allCommits));
+  });
+
+  const nextVersionIsHardcoded = pkg.nextVersionIsHardcoded();
+  // All commits are releasable if the version hardcoded in the package.json
+  // In this scenario, we want to publish regardless of the commit types
+  if (nextVersionIsHardcoded) {
+    return {
+      releasableCommits: commits,
+      unreleasableCommits: [],
+      nextVersionIsHardcoded,
+      shouldRelease: true,
+    };
+  }
+
+  const releasableCommits: Commit[] = [];
+  const unreleasableCommits: Commit[] = [];
+  for (const commit of commits) {
+    const headerIndicatesMajorChange = !!commit.header && commit.header.includes('!');
+    const bodyIndicatesMajorChange = !!commit.body && commit.body.includes('BREAKING');
+    const typeIsSkippable = skippableCommitTypes.includes(commit.type);
+    const isReleasable = !typeIsSkippable || bodyIndicatesMajorChange || headerIndicatesMajorChange;
+    if (isReleasable) {
+      releasableCommits.push(commit);
+    } else {
+      unreleasableCommits.push(commit);
+    }
+  }
+
+  return {
+    releasableCommits,
+    unreleasableCommits,
+    nextVersionIsHardcoded,
+    shouldRelease: nextVersionIsHardcoded || releasableCommits.length > 0,
+  };
+}

src/package.ts

@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import * as path from 'path';
-import { exec } from 'shelljs';
+import { exec, pwd } from 'shelljs';
 import { fs, Logger, SfdxError } from '@salesforce/core';
 import { AsyncOptionalCreatable } from '@salesforce/kit';
 import { AnyJson, get } from '@salesforce/ts-types';
@@ -57,9 +57,9 @@ export class Package extends AsyncOptionalCreatable {
   private nextVersion: string;
   private registry: Registry;
 
-  public constructor(location?: string) {
+  public constructor(location: string) {
     super();
-    this.location = location;
+    this.location = location || pwd().stdout;
     this.registry = new Registry();
   }