feat(core,npm,pnpm): add skip option to publish step

Author: dangreen

packages/core/src/project/project.types.ts

@@ -104,4 +104,8 @@ export interface ProjectReleaseOptions {
 export interface ProjectPublishOptions {
   dryRun?: boolean
   logger?: ChildLogger
+  /**
+   * Skip publishing.
+   */
+  skip?: boolean
 }

packages/core/src/releaser.ts

@@ -376,15 +376,21 @@ export class Releaser<
       const { project } = this
       const { dryRun } = this.options
       const logger = this.logger.createChild('package')
-
-      logger.info('Publishing...')
-
-      await project.publish({
+      const publishOptions = {
         dryRun,
         logger,
         ...this.stepsOptions.publish,
         ...options
-      })
+      }
+
+      if (publishOptions.skip) {
+        logger.verbose('Skipping publish')
+        return
+      }
+
+      logger.info('Publishing...')
+
+      await project.publish(publishOptions)
     })
   }
 

packages/npm/README.md

@@ -155,6 +155,10 @@ Function to format tag prefix from scope name. By default, tag prefix will be th
 
 Publish options for `NpmProject` and `NpmWorkspacesProject`.
 
+#### `skip`
+
+If true, skip publishing. Optional.
+
 #### `access`
 
 Access level for the package. Optional.

packages/npm/src/project.ts

@@ -19,6 +19,11 @@ export type NpmProjectPublishOptions = Omit<PublishOptions, 'workspaces'>
  */
 export class NpmProject extends PackageJsonProject {
   override async publish(options: NpmProjectPublishOptions = {}): Promise<void> {
+    if (options.skip) {
+      options.logger?.info('Skipping publish')
+      return
+    }
+
     await publish(this, options)
   }
 }

packages/npm/src/workspacesProject.ts

@@ -43,6 +43,11 @@ export class NpmWorkspacesProject extends PackageJsonMonorepoProject {
   }
 
   override async publish(options: NpmWorkspacesProjectPublishOptions = {}): Promise<void> {
+    if (options.skip) {
+      options.logger?.info('Skipping publish')
+      return
+    }
+
     await publish(this, {
       ...options,
       workspaces: true

packages/pnpm/README.md

@@ -155,6 +155,10 @@ Function to format tag prefix from scope name. By default, tag prefix will be th
 
 Publish options for `PnpmProject` and `PnpmWorkspacesProject`.
 
+#### `skip`
+
+If true, skip publishing. Optional.
+
 #### `access`
 
 Access level for the package. Optional.

packages/pnpm/src/project.ts

@@ -19,6 +19,11 @@ export type PnpmProjectPublishOptions = Omit<PublishOptions, 'workspaces'>
  */
 export class PnpmProject extends PackageJsonProject {
   override async publish(options: PnpmProjectPublishOptions = {}): Promise<void> {
+    if (options.skip) {
+      options.logger?.info('Skipping publish')
+      return
+    }
+
     await publish(this, options)
   }
 }

packages/pnpm/src/workspacesProject.ts

@@ -60,6 +60,11 @@ export class PnpmWorkspacesProject extends PackageJsonMonorepoProject {
   }
 
   override async publish(options: PnpmWorkspacesProjectPublishOptions = {}): Promise<void> {
+    if (options.skip) {
+      options.logger?.info('Skipping publish')
+      return
+    }
+
     await publish(this, {
       ...options,
       workspaces: true