[rush-lib] Abstract rush publish from npm only and introduce pluggable publish provider

.gitignore

@@ -135,5 +135,4 @@ playwright-report/
 test-results/
 
 # Claude Code local configuration
-.claude/*.local.json
-
+.claude/*.local.json

apps/rush/package.json

@@ -48,6 +48,8 @@
     "@rushstack/rush-amazon-s3-build-cache-plugin": "workspace:*",
     "@rushstack/rush-azure-storage-build-cache-plugin": "workspace:*",
     "@rushstack/rush-http-build-cache-plugin": "workspace:*",
+    "@rushstack/rush-npm-publish-plugin": "workspace:*",
+    "@rushstack/rush-vscode-publish-plugin": "workspace:*",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.5.0"
   }

apps/rush/src/start-dev.ts

@@ -31,6 +31,8 @@ includePlugin('rush-azure-storage-build-cache-plugin');
 includePlugin('rush-http-build-cache-plugin');
 // Including this here so that developers can reuse it without installing the plugin a second time
 includePlugin('rush-azure-interactive-auth-plugin', '@rushstack/rush-azure-storage-build-cache-plugin');
+includePlugin('rush-npm-publish-plugin');
+includePlugin('rush-vscode-publish-plugin');
 
 const currentPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;
 RushCommandSelector.execute(currentPackageVersion, rushLib, {

common/reviews/api/rush-lib.api.md

@@ -103,6 +103,22 @@ export class ChangeManager {
     static createEmptyChangeFiles(rushConfiguration: RushConfiguration, projectName: string, emailAddress: string): string | undefined;
 }
 
+// @beta
+export enum ChangeType {
+    // (undocumented)
+    dependency = 1,
+    // (undocumented)
+    hotfix = 2,
+    // (undocumented)
+    major = 5,
+    // (undocumented)
+    minor = 4,
+    // (undocumented)
+    none = 0,
+    // (undocumented)
+    patch = 3
+}
+
 // Warning: (ae-forgotten-export) The symbol "IBuildCacheJson" needs to be exported by the entry point index.d.ts
 //
 // @beta (undocumented)
@@ -799,6 +815,51 @@ export type _IProjectBuildCacheOptions = _IOperationBuildCacheOptions & {
     phaseName: string;
 };
 
+// @beta
+export interface IPublishCommand extends IRushCommand {
+    readonly dryRun: boolean;
+}
+
+// @beta
+export interface IPublishProjectInfo {
+    readonly changeType: ChangeType;
+    readonly newVersion: string;
+    readonly previousVersion: string;
+    readonly project: RushConfigurationProject;
+    readonly providerConfig: Record<string, unknown> | undefined;
+}
+
+// @beta
+export interface IPublishProvider {
+    checkExistsAsync(options: IPublishProviderCheckExistsOptions): Promise<boolean>;
+    packAsync(options: IPublishProviderPackOptions): Promise<void>;
+    readonly providerName: string;
+    publishAsync(options: IPublishProviderPublishOptions): Promise<void>;
+}
+
+// @beta
+export interface IPublishProviderCheckExistsOptions {
+    readonly project: RushConfigurationProject;
+    readonly providerConfig: Record<string, unknown> | undefined;
+    readonly version: string;
+}
+
+// @beta
+export interface IPublishProviderPackOptions {
+    readonly dryRun: boolean;
+    readonly logger: ILogger;
+    readonly projects: ReadonlyArray<IPublishProjectInfo>;
+    readonly releaseFolder: string;
+}
+
+// @beta
+export interface IPublishProviderPublishOptions {
+    readonly dryRun: boolean;
+    readonly logger: ILogger;
+    readonly projects: ReadonlyArray<IPublishProjectInfo>;
+    readonly tag: string | undefined;
+}
+
 // @beta
 export interface IRushCommand {
     readonly actionName: string;
@@ -1202,6 +1263,9 @@ export class ProjectChangeAnalyzer {
     _tryGetSnapshotProviderAsync(projectConfigurations: ReadonlyMap<RushConfigurationProject, RushProjectConfiguration>, terminal: ITerminal, projectSelection?: ReadonlySet<RushConfigurationProject>): Promise<GetInputsSnapshotAsyncFn | undefined>;
 }
 
+// @beta
+export type PublishProviderFactory = () => Promise<IPublishProvider>;
+
 // @public
 export class RepoStateFile {
     readonly filePath: string;
@@ -1389,6 +1453,7 @@ export class RushConfigurationProject {
     readonly projectRushConfigFolder: string;
     readonly projectRushTempFolder: string;
     readonly publishFolder: string;
+    get publishTargets(): ReadonlyArray<string>;
     readonly reviewCategory: string | undefined;
     readonly rushConfiguration: RushConfiguration;
     get shouldPublish(): boolean;
@@ -1492,11 +1557,13 @@ export class RushLifecycleHooks {
     subspace: Subspace,
     variant: string | undefined
     ]>;
+    readonly afterPublish: AsyncSeriesHook<[command: IPublishCommand]>;
     readonly beforeInstall: AsyncSeriesHook<[
     command: IGlobalCommand,
     subspace: Subspace,
     variant: string | undefined
     ]>;
+    readonly beforePublish: AsyncSeriesHook<[command: IPublishCommand]>;
     readonly flushTelemetry: AsyncParallelHook<[ReadonlyArray<ITelemetryData>]>;
     readonly initialize: AsyncSeriesHook<IRushCommand>;
     readonly runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
@@ -1536,12 +1603,16 @@ export class RushSession {
     // (undocumented)
     getLogger(name: string): ILogger;
     // (undocumented)
+    getPublishProviderFactory(publishTargetName: string): PublishProviderFactory | undefined;
+    // (undocumented)
     readonly hooks: RushLifecycleHooks;
     // (undocumented)
     registerCloudBuildCacheProviderFactory(cacheProviderName: string, factory: CloudBuildCacheProviderFactory): void;
     // (undocumented)
     registerCobuildLockProviderFactory(cobuildLockProviderName: string, factory: CobuildLockProviderFactory): void;
     // (undocumented)
+    registerPublishProviderFactory(publishTargetName: string, factory: PublishProviderFactory): void;
+    // (undocumented)
     get terminalProvider(): ITerminalProvider;
 }
 

libraries/rush-lib/package.json

@@ -93,7 +93,8 @@
   "publishOnlyDependencies": {
     "@rushstack/rush-amazon-s3-build-cache-plugin": "workspace:*",
     "@rushstack/rush-azure-storage-build-cache-plugin": "workspace:*",
-    "@rushstack/rush-http-build-cache-plugin": "workspace:*"
+    "@rushstack/rush-http-build-cache-plugin": "workspace:*",
+    "@rushstack/rush-npm-publish-plugin": "workspace:*"
   },
   "sideEffects": [
     "lib-esnext/start-pnpm.js",

libraries/rush-lib/scripts/plugins-prepublish.js

@@ -8,5 +8,7 @@ delete packageJson['publishOnlyDependencies'];
 packageJson.dependencies['@rushstack/rush-amazon-s3-build-cache-plugin'] = packageJson.version;
 packageJson.dependencies['@rushstack/rush-azure-storage-build-cache-plugin'] = packageJson.version;
 packageJson.dependencies['@rushstack/rush-http-build-cache-plugin'] = packageJson.version;
+packageJson.dependencies['@rushstack/rush-npm-publish-plugin'] = packageJson.version;
+packageJson.dependencies['@rushstack/rush-vscode-publish-plugin'] = packageJson.version;
 
 JsonFile.save(packageJson, packageJsonPath, { updateExistingFile: true });

libraries/rush-lib/src/api/ChangeManagement.ts

@@ -12,6 +12,7 @@ export interface IChangeFile {
 
 /**
  * Represents all of the types of change requests.
+ * @beta
  */
 export enum ChangeType {
   none = 0,

libraries/rush-lib/src/api/PublishConfiguration.ts

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { ProjectConfigurationFile, InheritanceType } from '@rushstack/heft-config-file';
+
+import publishSchemaJson from '../schemas/publish.schema.json';
+
+/**
+ * Represents the parsed contents of a project's `config/publish.json` file.
+ * @public
+ */
+export interface IPublishJson {
+  /**
+   * An object whose keys are publish target names (e.g. 'npm', 'vsix') and whose
+   * values are provider-specific configuration objects.
+   */
+  providers?: Record<string, Record<string, unknown>>;
+}
+
+/**
+ * The `ProjectConfigurationFile` instance for loading `config/publish.json` with
+ * rig resolution and property inheritance.
+ *
+ * @remarks
+ * The `providers` property uses custom inheritance: child provider sections are
+ * shallow-merged over parent provider sections. This means a project can override
+ * specific provider configs from a rig while inheriting others.
+ *
+ * @internal
+ */
+export const PUBLISH_CONFIGURATION_FILE: ProjectConfigurationFile<IPublishJson> =
+  new ProjectConfigurationFile<IPublishJson>({
+    projectRelativeFilePath: 'config/publish.json',
+    jsonSchemaObject: publishSchemaJson,
+    propertyInheritance: {
+      providers: {
+        inheritanceType: InheritanceType.custom,
+        inheritanceFunction: (
+          child: Record<string, Record<string, unknown>> | undefined,
+          parent: Record<string, Record<string, unknown>> | undefined
+        ): Record<string, Record<string, unknown>> | undefined => {
+          if (!child) {
+            return parent;
+          }
+          if (!parent) {
+            return child;
+          }
+          // Shallow merge: child provider sections override parent provider sections
+          return { ...parent, ...child };
+        }
+      }
+    }
+  });