oclif 4.15.0 → 4.15.2

package/lib/aws.d.ts

@@ -5,7 +5,7 @@ declare const _default: {
         createCloudfrontInvalidation: (options: CreateInvalidationRequest) => Promise<CreateInvalidationCommandOutput>;
     };
     readonly s3: {
-        copyObject: (options: CopyObjectRequest) => Promise<CopyObjectOutput>;
+        copyObject: (options: CopyObjectRequest, ignoreMissing?: boolean) => Promise<CopyObjectOutput>;
         deleteObjects: (options: DeleteObjectsRequest) => Promise<DeleteObjectsOutput>;
         getObject: (options: GetObjectRequest) => Promise<GetObjectOutput>;
         headObject: (options: HeadObjectRequest) => Promise<HeadObjectOutput>;

package/lib/aws.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const client_cloudfront_1 = require("@aws-sdk/client-cloudfront");
 const client_s3_1 = require("@aws-sdk/client-s3");
+const errors_1 = require("@oclif/core/errors");
 const fs_extra_1 = require("fs-extra");
 const log_1 = require("./log");
 const util_1 = require("./util");
@@ -59,12 +60,27 @@ exports.default = {
     },
     get s3() {
         return {
-            copyObject: (options) => new Promise((resolve, reject) => {
+            copyObject: (options, ignoreMissing = false) => new Promise((resolve, reject) => {
                 (0, log_1.log)('s3:copyObject', `from s3://${options.CopySource}`, `to s3://${options.Bucket}/${options.Key}`);
                 aws.s3
                     ?.send(new client_s3_1.CopyObjectCommand(options))
                     .then((data) => resolve(data))
-                    .catch((error) => reject(error));
+                    .catch((error) => {
+                    if (error.Code === 'NoSuchKey') {
+                        if (ignoreMissing) {
+                            (0, log_1.log)('s3:copyObject', `s3://${options.CopySource} does not exist - skipping because of --ignore-missing`);
+                            return;
+                        }
+                        reject(new errors_1.CLIError(`Failed to copy source object s3://${options.CopySource} to s3://${options.Bucket}/${options.Key} because the source object does not exist`, {
+                            suggestions: [
+                                'Use the "oclif upload" to upload the object first',
+                                'Use the "--targets" flag to specify existing targets',
+                                'Use the "--ignore-missing" flag to skip this error',
+                            ],
+                        }));
+                    }
+                    reject(error);
+                });
             }),
             deleteObjects: (options) => new Promise((resolve, reject) => {
                 debug('deleteObjects', `s3://${options.Bucket}`);

package/lib/commands/promote.d.ts

@@ -4,6 +4,7 @@ export default class Promote extends Command {
     static flags: {
         channel: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         deb: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        'ignore-missing': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         indexes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         macos: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'max-age': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;

package/lib/commands/promote.js

@@ -39,6 +39,9 @@ class Promote extends core_1.Command {
     static flags = {
         channel: core_1.Flags.string({ default: 'stable', description: 'Channel to promote to.', required: true }),
         deb: core_1.Flags.boolean({ char: 'd', description: 'Promote debian artifacts.' }),
+        'ignore-missing': core_1.Flags.boolean({
+            description: 'Ignore missing tarballs/installers and continue promoting the rest.',
+        }),
         indexes: core_1.Flags.boolean({ description: 'Append the promoted urls into the index files.' }),
         macos: core_1.Flags.boolean({ char: 'm', description: 'Promote macOS pkg.' }),
         'max-age': core_1.Flags.string({ char: 'a', default: '86400', description: 'Cache control max-age in seconds.' }),
@@ -51,6 +54,9 @@ class Promote extends core_1.Command {
     };
     async run() {
         const { flags } = await this.parse(Promote);
+        if (flags['ignore-missing']) {
+            this.warn("--ignore-missing flag is being used - This command will continue to run even if a promotion fails because it doesn't exist");
+        }
         const buildConfig = await Tarballs.buildConfig(flags.root, { targets: flags?.targets?.split(',') });
         const { config, s3Config } = buildConfig;
         const indexDefaults = {
@@ -70,7 +76,7 @@ class Promote extends core_1.Command {
         const cloudChannelKey = (shortKey) => path.join((0, upload_util_1.channelAWSDir)(flags.channel, s3Config), shortKey);
         // copy tarballs manifests
         if (buildConfig.targets.length > 0)
-            this.log(`Promoting buildmanifests & unversioned tarballs to ${flags.channel}`);
+            this.log(`\nPromoting buildmanifests & unversioned tarballs to ${flags.channel}`);
         const promoteManifest = async (target) => {
             const manifest = (0, upload_util_1.templateShortKey)('manifest', {
                 arch: target.arch,
@@ -85,7 +91,7 @@ class Promote extends core_1.Command {
                 ...awsDefaults,
                 CopySource: cloudBucketCommitKey(manifest),
                 Key: cloudChannelKey(unversionedManifest),
-            });
+            }, flags['ignore-missing']);
         };
         const promoteGzTarballs = async (target) => {
             const versionedTarGzName = (0, upload_util_1.templateShortKey)('versioned', {
@@ -105,7 +111,7 @@ class Promote extends core_1.Command {
                     ...awsDefaults,
                     CopySource: versionedTarGzKey,
                     Key: unversionedTarGzKey,
-                }),
+                }, flags['ignore-missing']),
                 ...(flags.indexes
                     ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedTarGzName, originalUrl: versionedTarGzKey })]
                     : []),
@@ -129,14 +135,14 @@ class Promote extends core_1.Command {
                     ...awsDefaults,
                     CopySource: versionedTarXzKey,
                     Key: unversionedTarXzKey,
-                }),
+                }, flags['ignore-missing']),
                 ...(flags.indexes
                     ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedTarXzName, originalUrl: versionedTarXzKey })]
                     : []),
             ]);
         };
         const promoteMacInstallers = async () => {
-            this.log(`Promoting macos pkgs to ${flags.channel}`);
+            this.log(`\nPromoting macos pkgs to ${flags.channel}`);
             const arches = (0, util_1.uniq)(buildConfig.targets.filter((t) => t.platform === 'darwin').map((t) => t.arch));
             await Promise.all(arches.map(async (arch) => {
                 const darwinPkg = (0, upload_util_1.templateShortKey)('macos', { arch, bin: config.bin, sha: flags.sha, version: flags.version });
@@ -148,7 +154,7 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: darwinCopySource,
                         Key: cloudChannelKey(unversionedPkg),
-                    }),
+                    }, flags['ignore-missing']),
                     ...(flags.indexes
                         ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedPkg, originalUrl: darwinCopySource })]
                         : []),
@@ -157,7 +163,7 @@ class Promote extends core_1.Command {
         };
         const promoteWindowsInstallers = async () => {
             // copy win exe
-            this.log(`Promoting windows exe to ${flags.channel}`);
+            this.log(`\nPromoting windows exe to ${flags.channel}`);
             const arches = buildConfig.targets.filter((t) => t.platform === 'win32').map((t) => t.arch);
             await Promise.all(arches.map(async (arch) => {
                 const winPkg = (0, upload_util_1.templateShortKey)('win32', { arch, bin: config.bin, sha: flags.sha, version: flags.version });
@@ -169,7 +175,7 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: winCopySource,
                         Key: cloudChannelKey(unversionedExe),
-                    }),
+                    }, flags['ignore-missing']),
                     ...(flags.indexes
                         ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedExe, originalUrl: winCopySource })]
                         : []),
@@ -195,7 +201,7 @@ class Promote extends core_1.Command {
                 'InRelease',
                 'Release.gpg',
             ];
-            this.log(`Promoting debian artifacts to ${flags.channel}`);
+            this.log(`\nPromoting debian artifacts to ${flags.channel}`);
             await Promise.all(debArtifacts.flatMap((artifact) => {
                 const debCopySource = cloudBucketCommitKey(`apt/${artifact}`);
                 const debKey = cloudChannelKey(`apt/${artifact}`);
@@ -209,12 +215,12 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: debCopySource,
                         Key: debKey,
-                    }),
+                    }, flags['ignore-missing']),
                     aws_1.default.s3.copyObject({
                         ...awsDefaults,
                         CopySource: debCopySource,
                         Key: workaroundKey,
-                    }),
+                    }, flags['ignore-missing']),
                 ];
             }));
         };

package/lib/readme-generator.js

@@ -152,7 +152,7 @@ class ReadmeGenerator {
         const title = (0, ejs_1.render)(c.summary ?? c.description ?? '', { command: c, config: this.config })
             .trim()
             .split('\n')[0];
-        const help = new HelpClass(this.config, { maxWidth: columns, stripAnsi: true });
+        const help = new HelpClass(this.config, { maxWidth: columns, respectNoCacheDefault: true, stripAnsi: true });
         const wrapper = new help_compatibility_1.HelpCompatibilityWrapper(help);
         const header = () => {
             const usage = this.commandUsage(c);

package/oclif.manifest.json

@@ -381,6 +381,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "ignore-missing": {
+          "description": "Ignore missing tarballs/installers and continue promoting the rest.",
+          "name": "ignore-missing",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "indexes": {
           "description": "Append the promoted urls into the index files.",
           "name": "indexes",
@@ -1087,5 +1093,5 @@
       ]
     }
   },
-  "version": "4.15.0"
+  "version": "4.15.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.15.0",
+  "version": "4.15.2",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"
@@ -13,7 +13,7 @@
     "@inquirer/confirm": "^3.1.22",
     "@inquirer/input": "^2.2.4",
     "@inquirer/select": "^2.5.0",
-    "@oclif/core": "^4",
+    "@oclif/core": "^4.0.27",
     "@oclif/plugin-help": "^6.2.10",
     "@oclif/plugin-not-found": "^3.2.21",
     "@oclif/plugin-warn-if-update-available": "^3.1.11",