[rush] Expose hasUncommittedChanges
flag on input snapshot
#5222
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
Adds a flag
hasUncommittedChanges
to the metadata for the input snapshot that plugins can use to identify if the current repository state has uncommitted changes. This is useful if trying to tie state to a git commit.Details
Adds
getDetailedRepoStateAsync
API to@rushstack/package-deps-hash
to exposehasUncommittedChanges
andhasSubmodules
in addition to the existingfiles
map. The information to compute these fields was already available in the calculation ofgetRepoStateAsync
.Updates
getRepoStateAsync
to just be a wrapper aroundgetDetailedRepoStateAsync
that extracts and returns thefiles
property.How it was tested
Updated the existing unit tests for
getRepoStateAsync
to instead operate on the expanded data ofgetDetailedRepoStateAsync
.Impacted documentation
The API doc for
@rushstack/package-deps-hash
, API forIInputsSnapshot
in rush-lib.