Fix error message in CodeCheck file #50375
Merged
Conversation
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
ghost
added
area-infrastructure
|
Hey @dotnet/aspnet-build, looks like this PR is something you want to take a look at. |
Tratcher
approved these changes
Aug 28, 2023
Tratcher
reviewed
Aug 28, 2023
Tratcher
reviewed
Aug 28, 2023
eng/scripts/CodeCheck.ps1
Outdated
| @@ -263,7 +263,9 @@ try { | |||
|
|
|||
| if ($changedAPIBaselines.count -gt 0) { | |||
| LogError ("Detected modification to baseline API files. PublicAPI.Shipped.txt files should only " + | |||
| "be updated after a major release. See /docs/APIBaselines.md for more information.") | |||
| "be updated after a major release, and PublicAPI.Unshipped.txt files should not " + | |||
| "be updated in release branches. If this is a preview or rc branch and you've updated a PublicAPI.Unshipped.txt " + | |||
There was a problem hiding this comment.
The script exempts preview branches but not rc's.
wtgodbe
commented
Aug 28, 2023
| @@ -253,7 +253,7 @@ try { | |||
| } | |||
| } | |||
| # Check for changes in Unshipped in servicing branches | |||
| if ($targetBranch -like 'release*' -and $targetBranch -notlike '*preview*' -and $file -like '*PublicAPI.Unshipped.txt') { | |||
| if ($targetBranch -like 'release*' -and $targetBranch -notlike '*preview*' -and $targetBranch -notlike '*rc1*' -and $targetBranch -notlike '*rc2*' -and $file -like '*PublicAPI.Unshipped.txt') { | |||
There was a problem hiding this comment.
Did this instead of *rc* to decrease the odds of an accidental hit
wtgodbe
added
the
tell-mode
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.
This has been causing confusion lately. This PR improves the (previously incomplete) error message in the CodeCheck.ps1 script for PublicApi file changes.