@salesforce/cli 2.0.0-beta.30 → 2.0.0-beta.31

package/dist/hooks/display-release-notes.js

@@ -0,0 +1,47 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const core_1 = require("@oclif/core");
+const logError = (msg) => {
+    core_1.ux.log('NOTE: This error can be ignored in CI and may be silenced in the future');
+    core_1.ux.log('- Set the SF_HIDE_RELEASE_NOTES env var to "true" to skip this script\n');
+    core_1.ux.log(msg.toString());
+};
+/*
+ * NOTE: Please read "Notes about the hook scripts" in this PR before making changes:
+ * https://github.com/salesforcecli/sfdx-cli/pull/407
+ */
+const hook = async () => new Promise((resolve) => {
+    if (process.env.SFDX_HIDE_RELEASE_NOTES === 'true' || process.env.SF_HIDE_RELEASE_NOTES === 'true') {
+        resolve();
+    }
+    const executable = process.platform === 'win32' ? 'run.cmd' : 'run';
+    const cmd = (0, child_process_1.spawn)((0, path_1.join)(__dirname, '..', '..', 'bin', executable), ['whatsnew', '--hook'], {
+        stdio: ['ignore', 'inherit', 'pipe'],
+        timeout: 10000,
+    });
+    cmd.stderr.on('data', (error) => {
+        logError(error);
+        resolve();
+    });
+    cmd.on('error', (error) => {
+        logError(error);
+        resolve();
+    });
+    // 'exit' fires whether or not the stream are finished
+    cmd.on('exit', () => {
+        resolve();
+    });
+    cmd.on('close', () => {
+        resolve();
+    });
+});
+exports.default = hook;
+//# sourceMappingURL=display-release-notes.js.map

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@salesforce/cli",
-  "version": "2.0.0-beta.30",
+  "version": "2.0.0-beta.31",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@salesforce/cli",
-      "version": "2.0.0-beta.30",
+      "version": "2.0.0-beta.31",
       "hasInstallScript": true,
       "license": "BSD-3-Clause",
       "dependencies": {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.0-beta.30",
+  "version": "2.0.0-beta.31",
   "commands": {
     "cmdt:generate:field": {
       "id": "cmdt:generate:field",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/cli",
   "description": "The Salesforce CLI",
-  "version": "2.0.0-beta.30",
+  "version": "2.0.0-beta.31",
   "author": "Salesforce",
   "bin": {
     "sf": "./bin/run",
@@ -18,7 +18,8 @@
     "/dist/**/*.js",
     "/oclif.manifest.json",
     "/npm-shrinkwrap.json",
-    "/scripts/preinstall.js"
+    "/scripts/preinstall.js",
+    "/scripts/post-install-release-notes.js"
   ],
   "keywords": [
     "oclif",
@@ -85,7 +86,8 @@
     "hooks": {
       "preupdate": "./dist/hooks/preupdate",
       "command_incomplete": "./dist/hooks/incomplete",
-      "plugins:preinstall": "./dist/hooks/pluginsPreinstall.js"
+      "plugins:preinstall": "./dist/hooks/pluginsPreinstall.js",
+      "update": "./dist/hooks/display-release-notes.js"
     },
     "update": {
       "s3": {
@@ -206,6 +208,7 @@
     "pack:win": "oclif pack:win",
     "postpack": "rm -f oclif.manifest.json npm-shrinkwrap.json",
     "preinstall": "node ./scripts/preinstall.js",
+    "postinstall": "node ./scripts/post-install-release-notes.js",
     "prepack": "sf-prepack",
     "prepare": "sf-install && yarn compile && yarn lint",
     "prepublishOnly": "npm shrinkwrap",

package/scripts/post-install-release-notes.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+const { spawn } = require('child_process');
+const { join } = require('path');
+
+if (process.env.SFDX_HIDE_RELEASE_NOTES === 'true' || process.env.SF_HIDE_RELEASE_NOTES === 'true') process.exit(0);
+
+const logAndExit = (msg) => {
+  console.log('NOTE: This error can be ignored in CI and may be silenced in the future');
+  console.log('- Set the SF_HIDE_RELEASE_NOTES env var to "true" to skip this script\n');
+  console.log(msg.toString());
+
+  process.exit(0);
+};
+
+/*
+ * NOTE: Please read "Notes about the hook scripts" in this PR before making changes:
+ * https://github.com/salesforcecli/sfdx-cli/pull/407
+ */
+
+var executable = process.platform === 'win32' ? 'run.cmd' : 'run';
+
+var cmd = spawn(join(__dirname, '..', 'bin', executable), ['whatsnew', '--hook'], {
+  stdio: ['ignore', 'inherit', 'pipe'],
+  timeout: 10000,
+});
+
+cmd.stderr.on('data', (error) => {
+  logAndExit(error);
+});
+
+cmd.on('error', (error) => {
+  logAndExit(error);
+});
+
+// 'exit' fires whether or not the stream are finished
+cmd.on('exit', (code) => {
+  process.exit(0);
+});