-
Notifications
You must be signed in to change notification settings - Fork 10.5k
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
Conversation
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.
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 |
captainsafia
left a comment
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.
Looks good overall! I agree a little bit with Copilot's comment. Even though the URLs aren't case-sensitive maybe we just normalize to lowercase since the CodeCheck scripts assume lowercase as well?
| } | ||
| } | ||
|
|
||
| # Check for relevant changes to SignalR typescript files |
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?
wtgodbe
left a comment
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.
LGTM modulo a couple nits
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