-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Add Changelog for SignalR typescript client #63392
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
BrennanConroy
wants to merge
3
commits into
main
Choose a base branch
from
brecon/changelog
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -213,6 +213,25 @@ try { | |||||||||||||
| LogError $file | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
|
|
||||||||||||||
| # Check for relevant changes to SignalR typescript files | ||||||||||||||
| $tsChanges = $changedFilesFromTarget | Where-Object { $_ -like "src/SignalR/clients/ts/*" -and $_ -ne "src/SignalR/clients/ts/changelog.md" } | ||||||||||||||
| $changelogChanged = $changedFilesFromTarget -contains "src/SignalR/clients/ts/changelog.md" | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog filename should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog filename should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||||||
| $signalrChangelogOverrideMarker = "[no changelog]" | ||||||||||||||
|
|
||||||||||||||
| # Only enforce changelog rule if there are relevant TS changes | ||||||||||||||
| if ($tsChanges.Count -gt 0 -and -not $changelogChanged) { | ||||||||||||||
| # Check if the override marker exists in recent commit messages | ||||||||||||||
| $hasOverride = git log origin/$targetBranch..HEAD --pretty=%B | Select-String -Pattern $signalrChangelogOverrideMarker -Quiet | ||||||||||||||
|
|
||||||||||||||
| if (-not $hasOverride) { | ||||||||||||||
| LogError "Changes were made to 'src/SignalR/clients/ts/', but no update to 'changelog.md' was found." | ||||||||||||||
| LogError "Either update 'src/SignalR/clients/ts/changelog.md' or include '$signalrChangelogOverrideMarker' in your commit message." | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog filename in the error message should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||||||
| exit 1 | ||||||||||||||
| } else { | ||||||||||||||
| Write-Host "SignalR Changelog update skipped due to override marker in commit message." | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| } | ||||||||||||||
| finally { | ||||||||||||||
|
|
||||||||||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| Change log contains changes for both @microsoft/signalr and @microsoft/signalr-protocol-msgpack. | ||
|
|
||
| ## v10.0.0-preview.1.25120.3 | ||
BrennanConroy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Replaced deprecated `substr` usage with `substring` [#58732](https://github.com/dotnet/aspnetcore/pull/58732) | ||
| - Bumped `ws` dependency to fix component vulnerability [#57536](https://github.com/dotnet/aspnetcore/pull/57536) | ||
| - Bumped `webpack` from 5.93.0 to 5.94.0 [#57592](https://github.com/dotnet/aspnetcore/pull/57592) | ||
|
|
||
| ## v9.0.0 | ||
| - Bumped `ws` dependency to address security vulnerability [#58458](https://github.com/dotnet/aspnetcore/pull/58458) | ||
|
|
||
| ## v9.0.0-rc.2.24474.3 | ||
| - Added `Partitioned` flag to cookie for SignalR browser testing [#57997](https://github.com/dotnet/aspnetcore/pull/57997) | ||
|
|
||
| ## v9.0.0-preview.7.24406.2 | ||
| - Reverted split Node dependency workaround due to issues [#56766](https://github.com/dotnet/aspnetcore/pull/56766) | ||
|
|
||
| ## v9.0.0-preview.1.24081.5 | ||
| - Updated Karma config [#53247](https://github.com/dotnet/aspnetcore/pull/53247) | ||
| - Node.js and npm infrastructure improvements [#53154](https://github.com/dotnet/aspnetcore/pull/53154) | ||
| - Improved error handling in SignalR client: rejected promises in invocation messages [#52523](https://github.com/dotnet/aspnetcore/pull/52523) | ||
| - Reordered SignalR message parameters for better readability [#51559](https://github.com/dotnet/aspnetcore/pull/51559) | ||
|
|
||
| ## v8.0.12 | ||
| - Updated `serialize-javascript` dependency [#58466](https://github.com/dotnet/aspnetcore/pull/58466) | ||
|
|
||
| ## v8.0.10 | ||
| - Upgraded `ws` from 7 to 7.5.10 [#57411](https://github.com/dotnet/aspnetcore/pull/57411) | ||
|
|
||
| ## v8.0.7 | ||
| - Reverted incorrect handling of Node dependency splitting [#55229](https://github.com/dotnet/aspnetcore/pull/55229) | ||
| - Fixed error handling for rejected promises in incoming Invocation messages [#55230](https://github.com/dotnet/aspnetcore/pull/55230) | ||
|
|
||
| ## v8.0.2 | ||
| - Updated Karma config [#53411](https://github.com/dotnet/aspnetcore/pull/53411) | ||
|
|
||
| ## v8.0.0-rc.2.23480.2 | ||
| - Introduced **Stateful Reconnect** support in SignalR [#49940](https://github.com/dotnet/aspnetcore/pull/49940) | ||
| - Renamed internal `UseAck` to `UseStatefulReconnect` [#50407](https://github.com/dotnet/aspnetcore/pull/50407) | ||
| - Incremented HubProtocol version for Stateful Reconnect [#50442](https://github.com/dotnet/aspnetcore/pull/50442) | ||
|
|
||
| ## v8.0.0-preview.7.23375.9 | ||
| - Removed `__non_webpack_require__` workaround, improved Node dependency handling [#48154](https://github.com/dotnet/aspnetcore/pull/48154) | ||
|
|
||
| ## v8.0.0-preview.6.23329.11 | ||
| - SignalR client now sends `CloseMessage` to server [#48577](https://github.com/dotnet/aspnetcore/pull/48577) | ||
|
|
||
| ## v8.0.0-preview.5.23302.2 | ||
| - Fixed cookie handling with Fetch API on Node 18+ [#48076](https://github.com/dotnet/aspnetcore/pull/48076) | ||
|
|
||
| ## v8.0.0-preview.4.23260.4 | ||
| - Upgraded Webpack for SignalR builds [#47403](https://github.com/dotnet/aspnetcore/pull/47403) | ||
|
|
||
| ## v8.0.0-preview.1.23112.2 | ||
| - Fixed `CompletionMessage` handling for `false`/`null` result values [#45169](https://github.com/dotnet/aspnetcore/pull/45169) | ||
| - Enabled `ServerTimeout` and `KeepAliveInterval` options in `HubConnectionBuilder` [#46065](https://github.com/dotnet/aspnetcore/pull/46065) | ||
| - Migrated links to `learn.microsoft.com` [#46206](https://github.com/dotnet/aspnetcore/pull/46206) | ||
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,5 +1,7 @@ | ||||||
| MsgPack support for SignalR for ASP.NET Core | ||||||
|
|
||||||
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/changelog.md) | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog link is incorrect. It should point to 'CHANGELOG.md' (uppercase) as that's the actual filename created in the diff, not 'changelog.md' (lowercase).
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| ```bash | ||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,5 +1,7 @@ | ||||||
| JavaScript and TypeScript clients for SignalR for ASP.NET Core and Azure SignalR Service | ||||||
|
|
||||||
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/changelog.md) | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The changelog link is incorrect. It should point to 'CHANGELOG.md' (uppercase) as that's the actual filename created in the diff, not 'changelog.md' (lowercase).
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| ```bash | ||||||
|
|
||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wtgodbe Could I get your review/approval of the infra changes?