Skip to content

Conversation

@BrennanConroy
Copy link
Member

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

Copilot AI review requested due to automatic review settings August 22, 2025 21:13
@BrennanConroy BrennanConroy added the area-signalr Includes: SignalR clients and servers label Aug 22, 2025
@BrennanConroy BrennanConroy requested review from a team, halter73 and wtgodbe as code owners August 22, 2025 21:13
Copy link
Contributor

Copilot AI left a 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

Copy link
Member

@captainsafia captainsafia left a 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
Copy link
Member Author

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?

@dotnet-policy-service dotnet-policy-service bot added the pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun label Sep 4, 2025
Copy link
Member

@wtgodbe wtgodbe left a 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

@BrennanConroy BrennanConroy enabled auto-merge (squash) November 17, 2025 19:28
@BrennanConroy BrennanConroy merged commit 09d6808 into main Nov 17, 2025
30 checks passed
@BrennanConroy BrennanConroy deleted the brecon/changelog branch November 17, 2025 20:50
@dotnet-policy-service dotnet-policy-service bot added this to the 11.0-preview1 milestone Nov 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-signalr Includes: SignalR clients and servers pending-ci-rerun When assigned to a PR indicates that the CI checks should be rerun

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants