Update labels for breaking change notifications #28635
Open
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
isra-fel
requested review from
NoriZC,
Pan-Qi,
VeryEarly,
YanaXu,
dolauli,
notyashhh,
vidai-msft and
wyunchi-ms
as code owners
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the labeling and messaging for breaking change notifications in the GitHub workflow script to improve clarity and accuracy. The changes ensure that the label and notification message better reflect how breaking changes are actually detected in the pipeline.
- Updated the label from "Breaking Change Release" to "Contains Breaking Change" to better describe the content
- Revised the notification message to clarify that breaking changes are detected by static analysis pipeline
| "Contains Breaking Change" = @" | ||
| To the author of the pull request, | ||
| This PR was labeled "Breaking Change Release" because it contains breaking changes. | ||
| This PR was labeled "Contains Breaking Change" because breaking changes are detected by the static analysis pipeline. |
There was a problem hiding this comment.
Suggested change
| This PR was labeled "Contains Breaking Change" because breaking changes are detected by the static analysis pipeline. | |
| This PR was labeled "Contains Breaking Change" because breaking changes have been detected by the static analysis pipeline. |
There was a problem hiding this comment.
nitpick: this wording may sound more natural?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This pull request updates the label and message for breaking changes in the pull request workflow script to improve clarity and accuracy. The label now reflects that breaking changes are detected by static analysis, and the notification message has been revised to match.
Workflow notification improvements:
$CommentDictof.github/workflows/script/PrLabeled.ps1, and updated the message to clarify that breaking changes are detected by the static analysis pipeline.Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.