feat(cli): add publish command for asset publishing

Author: ren-yamanashi

packages/@aws-cdk/toolkit-lib/lib/api/io/toolkit-action.ts

@@ -7,6 +7,7 @@ export type ToolkitAction =
 | 'synth'
 | 'list'
 | 'diff'
+| 'publish'
 | 'deploy'
 | 'drift'
 | 'rollback'

packages/aws-cdk/lib/cli/cdk-toolkit.ts

@@ -374,6 +374,30 @@ export class CdkToolkit {
     return diffs && options.fail ? 1 : 0;
   }
 
+  public async publish(options: PublishOptions) {
+    const buildAsset = async (assetNode: AssetBuildNode) => {
+      await this.props.deployments.buildSingleAsset(
+        assetNode.assetManifestArtifact,
+        assetNode.assetManifest,
+        assetNode.asset,
+        {
+          stack: assetNode.parentStack,
+          roleArn: options.roleArn,
+          stackName: assetNode.parentStack.stackName,
+        },
+      );
+    };
+
+    const publishAsset = async (assetNode: AssetPublishNode) => {
+      await this.props.deployments.publishSingleAsset(assetNode.assetManifest, assetNode.asset, {
+        stack: assetNode.parentStack,
+        roleArn: options.roleArn,
+        stackName: assetNode.parentStack.stackName,
+        forcePublish: options.force,
+      });
+    };
+  }
+
   public async deploy(options: DeployOptions) {
     if (options.watch) {
       return this.watch(options);
@@ -1679,6 +1703,19 @@ interface WatchOptions extends Omit<CfnDeployOptions, 'execute'> {
   readonly concurrency?: number;
 }
 
+export interface PublishOptions {
+  /**
+   * Role to pass to CloudFormation for asset publishing
+   */
+  roleArn?: string;
+
+  /**
+   * Always publish, even if it already exists
+   * @default false
+   */
+  force?: boolean;
+}
+
 export interface DeployOptions extends CfnDeployOptions, WatchOptions {
   /**
    * ARNs of SNS topics that CloudFormation will notify with stack related events

packages/aws-cdk/lib/cli/cli-config.ts

@@ -136,6 +136,12 @@ export async function makeConfig(): Promise<CliConfig> {
           concurrency: { type: 'number', alias: ['n'], desc: 'Maximum number of simultaneous synths to execute.', default: 4, requiresArg: true },
         },
       },
+      'publish': {
+        description: 'Publishes synthesized assets (e.g. Docker images, Lambda ZIPs, S3 files) to their destinations',
+        options: {
+          force: { alias: 'f', type: 'boolean', desc: 'Always publish, even if it already exists', default: false },
+        },
+      },
       'deploy': {
         description: 'Deploys the stack(s) named STACKS into your AWS account',
         options: {

packages/aws-cdk/lib/cli/cli-type-registry.json

@@ -407,6 +407,17 @@
         }
       }
     },
+    "publish": {
+      "description": "Publishes synthesized assets (e.g. Docker images, Lambda ZIPs, S3 files) to their destinations",
+      "options": {
+        "force": {
+          "alias": "f",
+          "type": "boolean",
+          "desc": "Always publish, even if it already exists",
+          "default": false
+        }
+      }
+    },
     "deploy": {
       "description": "Deploys the stack(s) named STACKS into your AWS account",
       "options": {

packages/aws-cdk/lib/cli/cli.ts

@@ -372,6 +372,13 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
           },
         });
 
+      case 'publish':
+        ioHost.currentAction = 'publish';
+        return cli.publish({
+          roleArn: args.roleArn,
+          force: args.force,
+        });
+
       case 'deploy':
         ioHost.currentAction = 'deploy';
         const parameterMap: { [name: string]: string | undefined } = {};

packages/aws-cdk/lib/cli/convert-to-user-input.ts

@@ -112,6 +112,12 @@ export function convertYargsToUserInput(args: any): UserInput {
       };
       break;
 
+    case 'publish':
+      commandOptions = {
+        force: args.force,
+      };
+      break;
+
     case 'deploy':
       commandOptions = {
         all: args.all,
@@ -399,6 +405,9 @@ export function convertConfigToUserInput(config: any): UserInput {
     safe: config.flags?.safe,
     concurrency: config.flags?.concurrency,
   };
+  const publishOptions = {
+    force: config.publish?.force,
+  };
   const deployOptions = {
     all: config.deploy?.all,
     buildExclude: config.deploy?.buildExclude,
@@ -536,6 +545,7 @@ export function convertConfigToUserInput(config: any): UserInput {
     bootstrap: bootstrapOptions,
     gc: gcOptions,
     flags: flagsOptions,
+    publish: publishOptions,
     deploy: deployOptions,
     rollback: rollbackOptions,
     import: importOptions,

packages/aws-cdk/lib/cli/parse-command-line-arguments.ts

@@ -430,6 +430,14 @@ export function parseCommandLineArguments(args: Array<string>): any {
           requiresArg: true,
         }),
     )
+    .command('publish', 'Publishes synthesized assets (e.g. Docker images, Lambda ZIPs, S3 files) to their destinations', (yargs: Argv) =>
+      yargs.option('force', {
+        default: false,
+        alias: 'f',
+        type: 'boolean',
+        desc: 'Always publish, even if it already exists',
+      }),
+    )
     .command('deploy [STACKS..]', 'Deploys the stack(s) named STACKS into your AWS account', (yargs: Argv) =>
       yargs
         .option('all', {

packages/aws-cdk/lib/cli/user-configuration.ts

@@ -17,6 +17,7 @@ export enum Command {
   LIST = 'list',
   DIFF = 'diff',
   BOOTSTRAP = 'bootstrap',
+  PUBLISH = 'publish',
   DEPLOY = 'deploy',
   DESTROY = 'destroy',
   SYNTHESIZE = 'synthesize',

packages/aws-cdk/lib/cli/user-input.ts

@@ -50,6 +50,11 @@ export interface UserInput {
    */
   readonly flags?: FlagsOptions;
 
+  /**
+   * Publishes synthesized assets (e.g. Docker images, Lambda ZIPs, S3 files) to their destinations
+   */
+  readonly publish?: PublishOptions;
+
   /**
    * Deploys the stack(s) named STACKS into your AWS account
    */
@@ -710,6 +715,22 @@ export interface FlagsOptions {
   readonly FLAGNAME?: Array<string>;
 }
 
+/**
+ * Publishes synthesized assets (e.g. Docker images, Lambda ZIPs, S3 files) to their destinations
+ *
+ * @struct
+ */
+export interface PublishOptions {
+  /**
+   * Always publish, even if it already exists
+   *
+   * aliases: f
+   *
+   * @default - false
+   */
+  readonly force?: boolean;
+}
+
 /**
  * Deploys the stack(s) named STACKS into your AWS account
  *

packages/aws-cdk/test/cli/cli-arguments.test.ts

@@ -125,6 +125,7 @@ describe('config', () => {
       }),
       context: expect.anything(),
       acknowledge: expect.anything(),
+      publish: expect.anything(),
       deploy: expect.anything(),
       destroy: expect.anything(),
       diff: expect.anything(),