Deprecation and eventual removal of API Versions

ArcanePlugins / Treasury

🏦 A powerful multi-platform library for next-level plugin integrations.

https://hangar.papermc.io/ArcanePlugins/Treasury

Other

57 stars 14 forks source link

Deprecation and eventual removal of API Versions #145

Closed lokka30 closed 2 years ago

lokka30 commented 2 years ago

I would also like to discuss a target plugin version for the complete removal of all associated classes and methods. :)

I think removing it in v1.2.0 could leave a damaged (albeit little to none) reputation of the library's stability. Perhaps v1.3.0?

MrIvanPlays commented 2 years ago

we will remove deprecated stuff in 2.0 in order to follow semver.

MrNemo64 commented 2 years ago

We could give a 5 minor updates time frame to remove deprecated APIs or with every major remove everything that's deprecated although the last option may not give much time to adapt in certain scenarios

MrIvanPlays commented 2 years ago

We could give a 5 minor updates time frame to remove deprecated APIs or with every major remove everything that's deprecated although the last option may not give much time to adapt in certain scenarios

im fairly sure we're releasing 1.1 and we're gonna stop the development for a bit ; start helping people to implement treasury support

lokka30 commented 2 years ago

We could give a 5 minor updates time frame to remove deprecated APIs or with every major remove everything that's deprecated although the last option may not give much time to adapt in certain scenarios

im fairly sure we're releasing 1.1 and we're gonna stop the development for a bit ; start helping people to implement treasury support

^^^ this.

so to remove deprecated stuff, the following factors are at play:

how many people are using the deprecated code
how long it has been since the code was marked as deprecated
how urgent we are to remove the deprecated code

for the API version removal, these are the factors:

few plugins are using the deprecated code
code was only marked as deprecated just now so we should wait either a major version or a month or so.
not urgent since it does not affect anything by using it

MrNemo64 commented 2 years ago

Sounds about right

MrNemo64 commented 2 years ago

Agree that per semver the deprecated methods should not be removed until 2.0, but there's no reason to not release a 2.0 even if it's exclusively to remove deprecated methods after a sufficient wait.

A mayor version that only removes deprecations? At leats we could also launch it with another of the APIs

MrIvanPlays commented 2 years ago

Agree that per semver the deprecated methods should not be removed until 2.0, but there's no reason to not release a 2.0 even if it's exclusively to remove deprecated methods after a sufficient wait.

A mayor version that only removes deprecations? At leats we could also launch it with another of the APIs

the other apis can be added in minor versions. major versions are for removing deprecations and having major, backwards incompatible changes on already existing code.