oclif 4.15.5 → 4.15.6

package/lib/aws.d.ts

@@ -5,12 +5,18 @@ declare const _default: {
         createCloudfrontInvalidation: (options: CreateInvalidationRequest) => Promise<CreateInvalidationCommandOutput>;
     };
     readonly s3: {
-        copyObject: (options: CopyObjectRequest, ignoreMissing?: boolean) => Promise<CopyObjectOutput>;
+        copyObject: (options: CopyObjectRequest, { dryRun, ignoreMissing, namespace }: {
+            dryRun?: boolean;
+            ignoreMissing?: boolean;
+            namespace?: string;
+        }) => Promise<CopyObjectOutput>;
         deleteObjects: (options: DeleteObjectsRequest) => Promise<DeleteObjectsOutput>;
         getObject: (options: GetObjectRequest) => Promise<GetObjectOutput>;
         headObject: (options: HeadObjectRequest) => Promise<HeadObjectOutput>;
         listObjects: (options: ListObjectsV2Request) => Promise<ListObjectsV2Output>;
-        uploadFile: (local: string, options: PutObjectRequest) => Promise<PutObjectOutput>;
+        uploadFile: (local: string, options: PutObjectRequest, { dryRun }?: {
+            dryRun?: boolean;
+        }) => Promise<PutObjectOutput>;
     };
 };
 export default _default;

package/lib/aws.js

@@ -3,6 +3,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 ux_1 = require("@oclif/core/ux");
 const fs_extra_1 = require("fs-extra");
 const log_1 = require("./log");
 const util_1 = require("./util");
@@ -60,17 +61,27 @@ exports.default = {
     },
     get s3() {
         return {
-            copyObject: (options, ignoreMissing = false) => new Promise((resolve, reject) => {
-                (0, log_1.log)('s3:copyObject', `from s3://${options.CopySource}`, `to s3://${options.Bucket}/${options.Key}`);
+            copyObject: (options, { dryRun, ignoreMissing, namespace }) => new Promise((resolve, reject) => {
+                const logNamespace = namespace ? `> ${namespace}` : `> s3://${options.CopySource}`;
+                ux_1.ux.stdout(logNamespace);
+                ux_1.ux.stdout('  action: copy');
+                ux_1.ux.stdout(`  source: s3://${options.CopySource}`);
+                ux_1.ux.stdout(`  target: s3://${options.Bucket}/${options.Key}`);
+                ux_1.ux.stdout();
+                if (dryRun)
+                    return;
                 aws.s3
                     ?.send(new client_s3_1.CopyObjectCommand(options))
                     .then((data) => resolve(data))
                     .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`);
+                            ux_1.ux.stdout(logNamespace);
+                            ux_1.ux.stdout(`  warning: s3://${options.CopySource} does not exist - skipping because of --ignore-missing`);
                             return;
                         }
+                        ux_1.ux.stdout(logNamespace);
+                        ux_1.ux.stdout(`  error: s3://${options.CopySource} does not exist`);
                         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',
@@ -110,8 +121,14 @@ exports.default = {
                     .then((data) => resolve(data))
                     .catch((error) => reject(error));
             }),
-            uploadFile: (local, options) => new Promise((resolve, reject) => {
-                (0, log_1.log)('s3:uploadFile', (0, util_1.prettifyPaths)(local), `s3://${options.Bucket}/${options.Key}`);
+            uploadFile: (local, options, { dryRun } = {}) => new Promise((resolve, reject) => {
+                ux_1.ux.stdout(`> ${local}`);
+                ux_1.ux.stdout('  action: upload');
+                ux_1.ux.stdout(`  source: ${(0, util_1.prettifyPaths)(local)}`);
+                ux_1.ux.stdout(`  target: s3://${options.Bucket}/${options.Key}`);
+                ux_1.ux.stdout();
+                if (dryRun)
+                    return;
                 options.Body = (0, fs_extra_1.createReadStream)(local);
                 aws.s3
                     ?.send(new client_s3_1.PutObjectCommand(options))

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>;
+        'dry-run': 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>;

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.' }),
+        'dry-run': core_1.Flags.boolean({
+            description: 'Run the command without uploading to S3 or copying versioned tarballs/installers to channel.',
+        }),
         'ignore-missing': core_1.Flags.boolean({
             description: 'Ignore missing tarballs/installers and continue promoting the rest.',
         }),
@@ -57,6 +60,7 @@ class Promote extends core_1.Command {
         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");
         }
+        this.log(`Promoting v${flags.version} (${flags.sha}) to ${flags.channel} channel\n`);
         const buildConfig = await Tarballs.buildConfig(flags.root, { targets: flags?.targets?.split(',') });
         const { config, s3Config } = buildConfig;
         const indexDefaults = {
@@ -75,8 +79,6 @@ class Promote extends core_1.Command {
         const cloudBucketCommitKey = (shortKey) => path.join(s3Config.bucket, (0, upload_util_1.commitAWSDir)(flags.version, flags.sha, s3Config), shortKey);
         const cloudChannelKey = (shortKey) => path.join((0, upload_util_1.channelAWSDir)(flags.channel, s3Config), shortKey);
         // copy tarballs manifests
-        if (buildConfig.targets.length > 0)
-            this.log(`\nPromoting buildmanifests & unversioned tarballs to ${flags.channel}`);
         const promoteManifest = async (target) => {
             const manifest = (0, upload_util_1.templateShortKey)('manifest', {
                 arch: target.arch,
@@ -91,7 +93,11 @@ class Promote extends core_1.Command {
                 ...awsDefaults,
                 CopySource: cloudBucketCommitKey(manifest),
                 Key: cloudChannelKey(unversionedManifest),
-            }, flags['ignore-missing']);
+            }, {
+                dryRun: flags['dry-run'],
+                ignoreMissing: flags['ignore-missing'],
+                namespace: unversionedManifest,
+            });
         };
         const promoteGzTarballs = async (target) => {
             const versionedTarGzName = (0, upload_util_1.templateShortKey)('versioned', {
@@ -111,9 +117,20 @@ class Promote extends core_1.Command {
                     ...awsDefaults,
                     CopySource: versionedTarGzKey,
                     Key: unversionedTarGzKey,
-                }, flags['ignore-missing']),
+                }, {
+                    dryRun: flags['dry-run'],
+                    ignoreMissing: flags['ignore-missing'],
+                    namespace: unversionedTarGzName,
+                }),
                 ...(flags.indexes
-                    ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedTarGzName, originalUrl: versionedTarGzKey })]
+                    ? [
+                        (0, version_indexes_1.appendToIndex)({
+                            ...indexDefaults,
+                            dryRun: flags['dry-run'],
+                            filename: unversionedTarGzName,
+                            originalUrl: versionedTarGzKey,
+                        }),
+                    ]
                     : []),
             ]);
         };
@@ -135,14 +152,24 @@ class Promote extends core_1.Command {
                     ...awsDefaults,
                     CopySource: versionedTarXzKey,
                     Key: unversionedTarXzKey,
-                }, flags['ignore-missing']),
+                }, {
+                    dryRun: flags['dry-run'],
+                    ignoreMissing: flags['ignore-missing'],
+                    namespace: unversionedTarXzName,
+                }),
                 ...(flags.indexes
-                    ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedTarXzName, originalUrl: versionedTarXzKey })]
+                    ? [
+                        (0, version_indexes_1.appendToIndex)({
+                            ...indexDefaults,
+                            dryRun: flags['dry-run'],
+                            filename: unversionedTarXzName,
+                            originalUrl: versionedTarXzKey,
+                        }),
+                    ]
                     : []),
             ]);
         };
         const promoteMacInstallers = async () => {
-            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 });
@@ -154,16 +181,26 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: darwinCopySource,
                         Key: cloudChannelKey(unversionedPkg),
-                    }, flags['ignore-missing']),
+                    }, {
+                        dryRun: flags['dry-run'],
+                        ignoreMissing: flags['ignore-missing'],
+                        namespace: unversionedPkg,
+                    }),
                     ...(flags.indexes
-                        ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedPkg, originalUrl: darwinCopySource })]
+                        ? [
+                            (0, version_indexes_1.appendToIndex)({
+                                ...indexDefaults,
+                                dryRun: flags['dry-run'],
+                                filename: unversionedPkg,
+                                originalUrl: darwinCopySource,
+                            }),
+                        ]
                         : []),
                 ]);
             }));
         };
         const promoteWindowsInstallers = async () => {
             // copy win exe
-            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 });
@@ -175,9 +212,20 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: winCopySource,
                         Key: cloudChannelKey(unversionedExe),
-                    }, flags['ignore-missing']),
+                    }, {
+                        dryRun: flags['dry-run'],
+                        ignoreMissing: flags['ignore-missing'],
+                        namespace: unversionedExe,
+                    }),
                     ...(flags.indexes
-                        ? [(0, version_indexes_1.appendToIndex)({ ...indexDefaults, filename: unversionedExe, originalUrl: winCopySource })]
+                        ? [
+                            (0, version_indexes_1.appendToIndex)({
+                                ...indexDefaults,
+                                dryRun: flags['dry-run'],
+                                filename: unversionedExe,
+                                originalUrl: winCopySource,
+                            }),
+                        ]
                         : []),
                 ]);
                 core_1.ux.action.stop('successfully');
@@ -201,7 +249,6 @@ class Promote extends core_1.Command {
                 'InRelease',
                 'Release.gpg',
             ];
-            this.log(`\nPromoting debian artifacts to ${flags.channel}`);
             await Promise.all(debArtifacts.flatMap((artifact) => {
                 const debCopySource = cloudBucketCommitKey(`apt/${artifact}`);
                 const debKey = cloudChannelKey(`apt/${artifact}`);
@@ -215,12 +262,20 @@ class Promote extends core_1.Command {
                         ...awsDefaults,
                         CopySource: debCopySource,
                         Key: debKey,
-                    }, flags['ignore-missing']),
+                    }, {
+                        dryRun: flags['dry-run'],
+                        ignoreMissing: flags['ignore-missing'],
+                        namespace: debKey,
+                    }),
                     aws_1.default.s3.copyObject({
                         ...awsDefaults,
                         CopySource: debCopySource,
                         Key: workaroundKey,
-                    }, flags['ignore-missing']),
+                    }, {
+                        dryRun: flags['dry-run'],
+                        ignoreMissing: flags['ignore-missing'],
+                        namespace: workaroundKey,
+                    }),
                 ];
             }));
         };

package/lib/commands/upload/deb.d.ts

@@ -2,6 +2,7 @@ import { Command } from '@oclif/core';
 export default class UploadDeb extends Command {
     static description: string;
     static flags: {
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         root: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;

package/lib/commands/upload/deb.js

@@ -36,6 +36,7 @@ const upload_util_1 = require("../../upload-util");
 class UploadDeb extends core_1.Command {
     static description = 'Upload deb package built with `pack deb`.';
     static flags = {
+        'dry-run': core_1.Flags.boolean({ description: 'Run the command without uploading to S3.' }),
         root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),
     };
     async run() {
@@ -54,7 +55,9 @@ class UploadDeb extends core_1.Command {
         const cloudKeyBase = (0, upload_util_1.commitAWSDir)(config.pjson.version, buildConfig.gitSha, s3Config);
         const upload = (file) => {
             const cloudKey = `${cloudKeyBase}/apt/${file}`;
-            return aws_1.default.s3.uploadFile(dist(file), { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey });
+            return aws_1.default.s3.uploadFile(dist(file), { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey }, {
+                dryRun: flags['dry-run'],
+            });
         };
         // apt expects ../apt/dists/versionName/[artifacts] but oclif wants versions/sha/apt/[artifacts]
         // see https://github.com/oclif/oclif/issues/347 for the AWS-redirect that solves this
@@ -62,7 +65,9 @@ class UploadDeb extends core_1.Command {
         // with this, the docs are correct. The copies are all done in parallel so it shouldn't be too costly.
         const uploadWorkaround = (file) => {
             const cloudKey = `${cloudKeyBase}/apt/./${file}`;
-            return aws_1.default.s3.uploadFile(dist(file), { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey });
+            return aws_1.default.s3.uploadFile(dist(file), { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey }, {
+                dryRun: flags['dry-run'],
+            });
         };
         const uploadDeb = async (arch) => {
             const deb = (0, upload_util_1.templateShortKey)('deb', {

package/lib/commands/upload/macos.d.ts

@@ -2,6 +2,7 @@ import { Command, Interfaces } from '@oclif/core';
 export default class UploadMacos extends Command {
     static description: string;
     static flags: {
+        'dry-run': Interfaces.BooleanFlag<boolean>;
         root: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         targets: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
     };

package/lib/commands/upload/macos.js

@@ -36,6 +36,7 @@ const util_1 = require("../../util");
 class UploadMacos extends core_1.Command {
     static description = 'Upload macos installers built with `pack macos`.';
     static flags = {
+        'dry-run': core_1.Flags.boolean({ description: 'Run the command without uploading to S3.' }),
         root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),
         targets: core_1.Flags.string({
             char: 't',
@@ -61,7 +62,9 @@ class UploadMacos extends core_1.Command {
             const cloudKey = `${cloudKeyBase}/${templateKey}`;
             const localPkg = dist(`macos/${templateKey}`);
             if (fs.existsSync(localPkg))
-                await aws_1.default.s3.uploadFile(localPkg, { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey });
+                await aws_1.default.s3.uploadFile(localPkg, { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey }, {
+                    dryRun: flags['dry-run'],
+                });
             else
                 this.error('Cannot find macOS pkg', {
                     suggestions: ['Run "oclif pack macos" before uploading'],

package/lib/commands/upload/tarballs.d.ts

@@ -2,6 +2,7 @@ import { Command, Interfaces } from '@oclif/core';
 export default class UploadTarballs extends Command {
     static description: string;
     static flags: {
+        'dry-run': Interfaces.BooleanFlag<boolean>;
         root: Interfaces.OptionFlag<string, Interfaces.CustomOptions>;
         targets: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
         xz: Interfaces.BooleanFlag<boolean>;

package/lib/commands/upload/tarballs.js

@@ -35,6 +35,7 @@ const upload_util_1 = require("../../upload-util");
 class UploadTarballs extends core_1.Command {
     static description = 'Upload an oclif CLI to S3.';
     static flags = {
+        'dry-run': core_1.Flags.boolean({ description: 'Run the command without uploading to S3.' }),
         root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),
         targets: core_1.Flags.string({ char: 't', description: 'Comma-separated targets to upload (e.g.: linux-arm,win32-x64).' }),
         xz: core_1.Flags.boolean({ allowNo: true, description: 'Also upload xz.' }),
@@ -81,6 +82,8 @@ class UploadTarballs extends core_1.Command {
                     CacheControl: 'max-age=604800',
                     ContentType: 'application/gzip',
                     Key: cloudKey,
+                }, {
+                    dryRun: flags['dry-run'],
                 });
             };
             const maybeUploadManifest = async () => {
@@ -93,6 +96,8 @@ class UploadTarballs extends core_1.Command {
                         CacheControl: 'max-age=86400',
                         ContentType: 'application/json',
                         Key: cloudKey,
+                    }, {
+                        dryRun: flags['dry-run'],
                     });
                 }
                 core_1.ux.warn(`Cannot find buildmanifest ${local}. CLI will not be able to update itself.`);

package/lib/commands/upload/win.d.ts

@@ -2,6 +2,7 @@ import { Command } from '@oclif/core';
 export default class UploadWin extends Command {
     static description: string;
     static flags: {
+        'dry-run': import("@oclif/core/interfaces").BooleanFlag<boolean>;
         root: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         targets: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
     };

package/lib/commands/upload/win.js

@@ -35,6 +35,7 @@ const upload_util_1 = require("../../upload-util");
 class UploadWin extends core_1.Command {
     static description = 'Upload windows installers built with `pack win`.';
     static flags = {
+        'dry-run': core_1.Flags.boolean({ description: 'Run the command without uploading to S3.' }),
         root: core_1.Flags.string({ char: 'r', default: '.', description: 'Path to oclif CLI root.', required: true }),
         targets: core_1.Flags.string({ description: 'Comma-separated targets to pack (e.g.: win32-x64,win32-x86,win32-arm64).' }),
     };
@@ -71,7 +72,9 @@ class UploadWin extends core_1.Command {
             const localExe = dist(`win32/${templateKey}`);
             const cloudKey = `${cloudKeyBase}/${templateKey}`;
             if (fs.existsSync(localExe))
-                await aws_1.default.s3.uploadFile(localExe, { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey });
+                await aws_1.default.s3.uploadFile(localExe, { ...S3Options, CacheControl: 'max-age=86400', Key: cloudKey }, {
+                    dryRun: flags['dry-run'],
+                });
         };
         await Promise.all([uploadWin('x64'), uploadWin('x86'), uploadWin('arm64')]);
         (0, log_1.log)(`done uploading windows executables for v${config.version}-${buildConfig.gitSha}`);

package/lib/version-indexes.d.ts

@@ -1,5 +1,6 @@
 import { BuildConfig } from './tarballs';
 export declare const appendToIndex: (input: {
+    dryRun?: boolean;
     filename: string;
     maxAge: string;
     originalUrl: string;

package/lib/version-indexes.js

@@ -100,6 +100,8 @@ const appendToIndex = async (input) => {
         Bucket: s3Config.bucket,
         CacheControl: maxAge,
         Key: key,
+    }, {
+        dryRun: input.dryRun,
     });
     // cleans up local fs
     await fs.remove(jsonFileName);

package/oclif.manifest.json

@@ -381,6 +381,12 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "dry-run": {
+          "description": "Run the command without uploading to S3 or copying versioned tarballs/installers to channel.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "ignore-missing": {
           "description": "Ignore missing tarballs/installers and continue promoting the rest.",
           "name": "ignore-missing",
@@ -940,6 +946,12 @@
       "args": {},
       "description": "Upload deb package built with `pack deb`.",
       "flags": {
+        "dry-run": {
+          "description": "Run the command without uploading to S3.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "root": {
           "char": "r",
           "description": "Path to oclif CLI root.",
@@ -972,6 +984,12 @@
       "args": {},
       "description": "Upload macos installers built with `pack macos`.",
       "flags": {
+        "dry-run": {
+          "description": "Run the command without uploading to S3.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "root": {
           "char": "r",
           "description": "Path to oclif CLI root.",
@@ -1012,6 +1030,12 @@
       "args": {},
       "description": "Upload an oclif CLI to S3.",
       "flags": {
+        "dry-run": {
+          "description": "Run the command without uploading to S3.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "root": {
           "char": "r",
           "description": "Path to oclif CLI root.",
@@ -1058,6 +1082,12 @@
       "args": {},
       "description": "Upload windows installers built with `pack win`.",
       "flags": {
+        "dry-run": {
+          "description": "Run the command without uploading to S3.",
+          "name": "dry-run",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "root": {
           "char": "r",
           "description": "Path to oclif CLI root.",
@@ -1093,5 +1123,5 @@
       ]
     }
   },
-  "version": "4.15.5"
+  "version": "4.15.6"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "4.15.5",
+  "version": "4.15.6",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run.js"