Skip to content
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

BREAKING CHANGE: Use long type for reading PunchCard statistics, just in case #2949

Merged
merged 4 commits into from
Jan 8, 2025

Conversation

TimLovellSmith
Copy link
Contributor

@TimLovellSmith TimLovellSmith commented Jul 3, 2024

Future-proofing. Just because, any time you have an arbitrary statistical counter, there could be some really big counts.


Before the change?

Numeric values deserialize as int32, using StatisticsClient.

After the change?

Numeric values deserialize as int64, using StatisticsClient.

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

I don't see any docs for the PunchCard classes, which are where the API changes are.

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

PunchCard and PunchCardPoint public constructors accepting the old int array parameter types are added, just for backward compatibility. But the return type of CommitCount and GetCommitCountFor do have to change to long, which I guess is unfortunately, technically breaking.


@nickfloyd nickfloyd added Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR labels Jan 8, 2025
@nickfloyd nickfloyd changed the title Use long type for reading PunchCard statistics, just in case BREAKING CHANGE: Use long type for reading PunchCard statistics, just in case Jan 8, 2025
@nickfloyd nickfloyd merged commit 7fa5b0f into octokit:main Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants