Repository navigation
[heft] Allow packages to declare a default plugin - #6201
Merged
Yashwanth Reddy Verupaka (yashwanth195) merged 1 commit intoNov 13, 2026
Conversation
Collaborator
|
It annoys me that we ever allowed pluginName to be omitted, but this is the least bad way to fix, I guess. |
David Michon (dmichon-msft)
approved these changes
Nov 12, 2026
Yashwanth Reddy Verupaka (yashwanth195)
enabled auto-merge (squash)
November 12, 2026 23:56
Yashwanth Reddy Verupaka (yashwanth195)
disabled auto-merge
November 13, 2026 00:16
Yashwanth Reddy Verupaka (yashwanth195)
merged commit Nov 13, 2026
c2acd01
into
microsoft:main
5 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Allow plugin packages to declare
defaultPluginNameinheft-plugin.json. A package can then add named plugins without breaking existingheft.jsonreferences that omitpluginName.Details
pluginNametakes precedence over the package default.Includes focused tests, updated schema/template descriptions, and a minor changefile. This is a standalone change with no sharding behavior.
How it was tested
Windows, Node.js 24.22.1, Rush 5.182.0. Dependencies were installed from the lockfile with
node common\scripts\install-run-rush.js install --to @rushstack/heft(passed).node common\scripts\install-run-rush.js build --to @rushstack/heftapps\heftnode ..\..\common\scripts\install-run-rushx.js _phase:test --test-path-pattern HeftPluginConfiguration --disable-code-coveragenode common\scripts\install-run-rush.js change --verify --target-branch upstream/mainTests cover task and lifecycle defaults, explicit overrides, unknown explicit names, legacy single-plugin inference, ambiguous packages, invalid defaults, and mixed task/lifecycle packages. No sharding acceptance or coverage suites were run.
Impacted documentation
https://heft.rushstack.io/pages/configs/heft_json/
Updated the
pluginNamedescriptions inheft.schema.jsonand theheft.jsontemplate, and documenteddefaultPluginNameinheft-plugin.schema.json.