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

TheLarkInn · 2026-02-11T15:11:53Z

Addresses #5504

Architecture

The design follows the existing factory registration pattern from build cache plugins. Key components:

publishTarget field in rush.json -- Per-project string or array (e.g., "vsix", ["npm", "vsix"]). Defaults to ["npm"] when omitted for full backward compatibility. Special value "none" enables version-only mode. Validation enforces that "none" cannot be combined with other targets and that private: true packages cannot target "npm".
IPublishProvider interface -- Contract for publish plugins with publishAsync(), packAsync(), and checkExistsAsync() methods. Exported from the public API (as @beta) to enable third-party plugins.
RushSession registration -- registerPublishProviderFactory(targetName, factory) / getPublishProviderFactory(targetName) for lazy provider instantiation, following the registerCloudBuildCacheProviderFactory pattern.
Riggable config/publish.json -- Per-project configuration loaded via ProjectConfigurationFile with rig resolution. Provider-specific config sections (keyed by target name) are passed to providers via IPublishProjectInfo.providerConfig.
PublishAction refactor -- The action becomes an orchestrator: loads per-project publish config, groups projects by target, and dispatches to registered providers. npm-specific CLI flags (--registry, --npm-auth-token, --set-access-level) are merged into the npm provider's config at runtime. The --pack flag now dispatches through provider packAsync() methods instead of hardcoding npm pack logic.
rush-npm-publish-plugin -- Built-in plugin (registered by PluginManager) that extracts the existing npm publish logic from PublishAction. Implements packAsync() to run <packageManager> pack and move tarballs to the release folder. Zero configuration required for existing projects.
rush-vscode-publish-plugin -- New plugin that publishes VSIX files via vsce publish --azure-credential. Implements packAsync() to run vsce package --no-dependencies and produce .vsix artifacts. Reads vsixPathPattern and useAzureCredential from config/publish.json.
Lifecycle hooks -- beforePublish and afterPublish hooks on RushLifecycleHooks for cross-cutting concerns (auth setup, telemetry).
VS Code extension enablement -- The 4 VS Code extensions in rush.json gain shouldPublish: true and publishTarget: "vsix", enabling them to use rush change, rush version --bump, and rush publish.

Backward compatibility

All existing shouldPublish: true projects continue to work without any configuration changes -- publishTarget defaults to ["npm"], and the npm publish plugin is always built-in.

Recent changes

Added packAsync() to the IPublishProvider interface with a new IPublishProviderPackOptions type, so each provider defines what "packing" means for its artifact type
Refactored PublishAction's --pack flag to dispatch through providers (_packProjectViaProvidersAsync) instead of the old npm-hardcoded _npmPackAsync
Implemented packAsync() in NpmPublishProvider (runs <packageManager> pack, moves tarball to release folder) and VsixPublishProvider (runs vsce package --no-dependencies --out <path>)
Changed all publish provider API types from @public to @beta release tag
Exported ChangeType and IPublishProviderPackOptions from the public API
Renamed test fixture files for consistency
Removed AI-generated artifacts (CLAUDE.md, skills directory)

How it was tested

Unit tests for publishTarget validation in RushConfigurationProject (string normalization, array handling, "none" validation, private: true interaction)
Unit tests for RushSession publish provider factory registration (register, retrieve, duplicate rejection)
Unit tests for riggable config/publish.json loading (project-only, rig-only, merged, missing file)
Unit tests for NpmPublishProvider (publish flow, pack flow, check-exists, dry-run, config merging, .npmrc-publish handling)
Unit tests for VsixPublishProvider (publish flow, pack flow, dry-run, config defaults, check-exists always returns false)
Unit tests for RushLifecycleHooks (beforePublish / afterPublish hook invocation)
Unit tests verifying VS Code extension publishTarget configuration and version bump eligibility
Unit tests verifying publish dispatch routes VSIX-target projects to the correct provider

Impacted documentation

https://rushjs.io/pages/configs/rush_json/ (publishTarget field documentation)
https://rushjs.io/pages/maintainer/publishing/ (rush publish dispatch behavior, --pack flag)
https://rushjs.io/pages/maintainer/setup_policies/ (version policy interaction with publishTarget: "none")

The directory is already in .gitignore but was tracked before the rule was added.

Support single string or string array values for specifying publish targets per project (e.g., 'npm', 'vsix', 'none'). Empty arrays and non-string items are rejected by schema validation. This is the first step toward decoupling version bumping from npm-only publishing. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add optional publishTarget field (string | string[]) to the raw JSON interface for rush.json project entries, enabling type-safe access to the new schema field added in the previous commit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add private _publishTargets field and public publishTargets getter that normalizes the raw publishTarget value from rush.json: omitted defaults to ['npm'], a string is wrapped in an array, and arrays are preserved as-is. Updates tests to verify normalization behavior. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add three constructor validations for publishTarget: - "none" cannot be combined with other targets (e.g. ["npm", "none"]) - "none" is incompatible with lockstep version policies - Relax private:true check to only throw when targets include "npm", allowing private packages to publish as VSIX or other non-npm targets Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Cover lockstep version policy + 'none' rejection, individual version policy + 'none' acceptance, and shouldPublish + private + npm rejection. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add IPublishProjectInfo, IPublishProviderPublishOptions, IPublishProviderCheckExistsOptions, IPublishProvider, and PublishProviderFactory types following existing provider patterns. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add exports for IPublishProvider, IPublishProjectInfo, IPublishProviderPublishOptions, IPublishProviderCheckExistsOptions, and PublishProviderFactory from rush-lib barrel exports. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add _publishProviderFactories Map, registerPublishProviderFactory() with duplicate detection, and getPublishProviderFactory() getter following existing cloud build cache provider pattern. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Test register/retrieve, duplicate detection, unregistered returns undefined, and multiple target registration on RushSession. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add JSON schema with providers object property where keys are publish target names and values are provider-specific configuration objects. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Create PublishConfiguration.ts with IPublishJson interface and PUBLISH_CONFIGURATION_FILE ProjectConfigurationFile instance that supports rig resolution with custom provider inheritance merge. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Test project-only config, missing config returns undefined, rig-only config loading, and project+rig merge behavior with test fixtures. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add rush-npm-publish-plugin with package.json, rush-plugin-manifest, tsconfig, rig config, plugin entry point, and stub NpmPublishProvider. Register in rush.json with rush lockstep version policy. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add NpmPublishProvider class implementing IPublishProvider with publishAsync and checkExistsAsync methods. Handles registry URL configuration, auth tokens, .npmrc-publish home directory, pnpm --no-git-checks flag, and dry-run mode. Add semver dependency. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add @rushstack/rush-npm-publish-plugin to rush-lib's publishOnlyDependencies, PluginManager tryAddBuiltInPlugin calls, start-dev.ts dev-time loading, and plugins-prepublish.js transform. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

14 tests covering publishAsync (pnpm/yarn/npm args, tags, dry-run, registry URL, auth token, access level, error handling), checkExistsAsync (version exists, not found, spawn failure, build metadata normalization, single version response), and .npmrc-publish HOME env handling. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add _loadPublishConfigAsync method with caching that loads config/publish.json via PUBLISH_CONFIGURATION_FILE with rig resolution for each project. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Replace hardcoded npm publish logic with provider-based dispatch. Projects are now grouped by publishTargets, and each target's registered provider handles publishing and exists checks. CLI flags (--registry, --npm-auth-token, --set-access-level) are passed as providerConfig overrides for the npm target. 'none' targets are skipped. Missing provider registrations throw descriptive errors. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add rush-vscode-publish-plugin with VsixPublishProvider that publishes VSIX packages to VS Code Marketplace via vsce CLI. Supports configurable vsixPathPattern and useAzureCredential options. Registered as built-in plugin alongside rush-npm-publish-plugin. Includes 7 unit tests. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add IPublishCommand interface and two new AsyncSeriesHook instances to RushLifecycleHooks. Plugins can tap these hooks for setup/auth before publishing and cleanup/reporting after publishing completes. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add shouldPublish and publishTarget: ["vsix"] to the 4 VS Code extension projects so they participate in rush publish via the VSIX publish provider. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Add tests that validate the 4 VS Code extension projects in rush.json are correctly configured with shouldPublish: true and publishTarget: ["vsix"], and that vscode-shared remains unpublished. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

…for VSIX Add tests verifying VS Code extensions use individual versioning (no lockstep policy) and only target the 'vsix' publish provider, ensuring correct dispatch through the publish pipeline. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

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

libraries/rush-lib/src/api/test/repo/rush-publishtarget-array.json

.gitignore

.mcp.json

libraries/rush-lib/package.json

libraries/rush-lib/src/api/test/RushConfiguration.test.ts

libraries/rush-lib/src/cli/actions/PublishAction.ts

octogonz · 2026-02-12T03:08:13Z

We discussed this today:

💬 Community call: Rush publish provider design review.

I attached some meeting notes.

TheLarkInn · 2026-02-12T16:42:38Z

We discussed this today:

💬 Community call: Rush publish provider design review.

I attached some meeting notes.

I've implemented the design requirements we've agreed on here. Pack is now implemented and npm/vsix packing has been moved into their respective publishprovider (without removing the existing heft-vsix plugins today to preserve back-compat).

TheLarkInn · 2026-02-12T16:44:48Z

@iclanton What is the typical workflow for working around the CI errors that publishTarget is not supported (since we add a new publishTarget field for rush.json) and then implement it in place.

Should we just remove publishTarget change from rush.json and then implement it in a subsequent PR?

TheLarkInn and others added 26 commits February 7, 2026 23:15

artifacts and example of the claude workflow

5dbcf9d

add atomic workflow plugin to rushstack

0683ab2

Untrack research/ directory that was accidentally committed

e99ba6d

The directory is already in .gitignore but was tracked before the rule was added.

test(rush-lib): add comprehensive publishTarget validation tests

fba09e0

Cover lockstep version policy + 'none' rejection, individual version policy + 'none' acceptance, and shouldPublish + private + npm rejection. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

test(rush-lib): add unit tests for publish provider factory registration

895c676

Test register/retrieve, duplicate detection, unregistered returns undefined, and multiple target registration on RushSession. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

feat(rush-lib): create publish.schema.json for config/publish.json

9cad3b7

Add JSON schema with providers object property where keys are publish target names and values are provider-specific configuration objects. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

test(rush-lib): add unit tests for riggable config/publish.json loading

619e8c0

Test project-only config, missing config returns undefined, rig-only config loading, and project+rig merge behavior with test fixtures. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

feat(rush): enable VS Code extensions for VSIX publishing

6c61a5f

Add shouldPublish and publishTarget: ["vsix"] to the 4 VS Code extension projects so they participate in rush publish via the VSIX publish provider. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

TheLarkInn requested review from apostolisms, dmichon-msft, iclanton and octogonz as code owners February 11, 2026 15:11

TheLarkInn requested review from bmiddha and jxanthony as code owners February 11, 2026 15:11

github-project-automation bot added this to Bug Triage Feb 11, 2026

github-project-automation bot moved this to Needs triage in Bug Triage Feb 11, 2026

Delete CLAUDE.md

0d2064c

TheLarkInn changed the title ~~[rush-lib] Pluggable publish provider architecture for rush publish~~ [rush-lib] Decouple rush version and rush publish and introduce pluggable publish provider Feb 11, 2026

TheLarkInn linked an issue Feb 11, 2026 that may be closed by this pull request

[vs code extension publishing] - Allow rush change and version policies to be separate from npm publishing #5504

Open

37 tasks

TheLarkInn commented Feb 11, 2026

View reviewed changes

iclanton moved this from Needs triage to In Progress in Bug Triage Feb 11, 2026

iclanton reviewed Feb 11, 2026

View reviewed changes

libraries/rush-lib/package.json Outdated Show resolved Hide resolved

iclanton reviewed Feb 11, 2026

View reviewed changes

libraries/rush-lib/src/api/test/RushConfiguration.test.ts Outdated Show resolved Hide resolved

TheLarkInn added 4 commits February 11, 2026 20:47

remove mcp file

47c2319

remove ai artifacts

aad8dbe

rename fixtures appropriately

9b994ed

address PR feedback

37c223b

TheLarkInn commented Feb 11, 2026

View reviewed changes

libraries/rush-lib/src/cli/actions/PublishAction.ts Show resolved Hide resolved

TheLarkInn changed the title ~~[rush-lib] Decouple rush version and rush publish and introduce pluggable publish provider~~ [rush-lib] Abstract rush publish from npm only and introduce pluggable publish provider Feb 12, 2026

implement pack for base publish provider and use in both providers

55528d3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

TheLarkInn commented Feb 11, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

octogonz commented Feb 12, 2026

Uh oh!

TheLarkInn commented Feb 12, 2026

Uh oh!

TheLarkInn commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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

Are you sure you want to change the base?

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

Conversation

TheLarkInn commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Architecture

Backward compatibility

Recent changes

How it was tested

Impacted documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

octogonz commented Feb 12, 2026

Uh oh!

TheLarkInn commented Feb 12, 2026

Uh oh!

TheLarkInn commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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

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

TheLarkInn commented Feb 11, 2026 •

edited

Loading