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

Rollback breaking change on Game.getObjectById to follow Semantic Versioning #223

Closed
DiamondMofeng opened this issue Feb 11, 2023 · 2 comments
Labels

Comments

@DiamondMofeng
Copy link
Member

What happened

There is a breaking change to Game.getObjectById in the release 3.3.0, but only MINOR version was increased.

Over the past few months I've seen many players complains about this. Most of their old codes failed to pass Typescript's type checking because of the breaking change on Game.getObjectById.

What should we do

Publish a new minor version which brings Game.getObjectById(id:string) back.

Then we could publish a new major version to enable the strict check on type of Id.

@pyrodogg
Copy link
Member

I agree. This was my mistake in handling and packaging the update.

Unfortunately I don't have the time to jump through pushing a clean 3.3.1 release and then pushing the update to 4.0.0. That would definitely be proper under the guidelines of Semantic Versioning. I feel odd for indicating any major updates to the game since it's rare something significant happens and I let that distract me.

We've made contact over Discord now about access, but to note again if you make any PRs in the meantime, ping me on Discord and I should be able to follow-up on them clearer. If you do get access soon this would be a good point to jump in going through the process of pushing updates to DefinitelyTyped.

@DiamondMofeng
Copy link
Member Author

I find that there are other breaking changes like #211, #217. So I think we should checkout to a new branch from 926712d to solve this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants