Add Changelog for SignalR typescript client #63392
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a changelog system for the SignalR TypeScript client packages. It creates a comprehensive changelog documenting recent releases and implements automated validation to ensure the changelog stays updated when changes are made to the TypeScript client code.
Key Changes
- Adds a new changelog file documenting version history from v8.0.0-preview.1 through v10.0.0-preview.1
- Links to the changelog from both SignalR npm package README files
- Implements CI validation to enforce changelog updates when TypeScript client code changes
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| src/SignalR/clients/ts/CHANGELOG.md | New changelog file documenting release history and changes |
| src/SignalR/clients/ts/signalr/README.md | Added changelog link to main SignalR package README |
| src/SignalR/clients/ts/signalr-protocol-msgpack/README.md | Added changelog link to msgpack protocol package README |
| eng/scripts/CodeCheck.ps1 | Added validation logic to enforce changelog updates for TypeScript changes |
| @@ -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.
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).
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/changelog.md) | |
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/CHANGELOG.md) |
Copilot uses AI. Check for mistakes.
| @@ -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.
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).
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/changelog.md) | |
| [Changelog](https://github.com/dotnet/aspnetcore/tree/main/src/SignalR/clients/ts/CHANGELOG.md) |
Copilot uses AI. Check for mistakes.
|
|
||
| # 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.
The changelog filename should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
| $changelogChanged = $changedFilesFromTarget -contains "src/SignalR/clients/ts/changelog.md" | |
| $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" |
Copilot uses AI. Check for mistakes.
|
|
||
| # 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.
The changelog filename should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
| $changelogChanged = $changedFilesFromTarget -contains "src/SignalR/clients/ts/changelog.md" | |
| $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" |
Copilot uses AI. Check for mistakes.
|
|
||
| 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.
The changelog filename in the error message should be 'CHANGELOG.md' (uppercase) to match the actual file created, not 'changelog.md' (lowercase).
| LogError "Either update 'src/SignalR/clients/ts/changelog.md' or include '$signalrChangelogOverrideMarker' in your commit message." | |
| LogError "Either update 'src/SignalR/clients/ts/CHANGELOG.md' or include '$signalrChangelogOverrideMarker' in your commit message." |
Copilot uses AI. Check for mistakes.
Add a changelog for recent releases
Link to changelog from both npm packages
Add codecheck for CI to fail if a change was made to the npm projects and the changelog wasn't updated
See #50772