API versioning and deprecation

openenclave / openenclave

SDK for developing enclaves

https://openenclave.io/sdk/

MIT License

1.06k stars 357 forks source link

API versioning and deprecation #2567

Open yentsanglee opened 4 years ago

yentsanglee commented 4 years ago

In the past, we’ve been using OE_API_VERSION as discussed in issue #2336. However, that version number does not match our release version. We need guidance on API versioning and deprecation before/after release 1.0.

jhand2 commented 4 years ago

@jhand2 to link to @dthaler's PR about API deprecation guidelines

CodeMonkeyLeet commented 4 years ago

The docs should probably make it clear that the OE_API_VERSION is not related to the SDK release version in anyway.

Per #2543 though, before we hit v1.0 of the OE SDK release, we would probably want to reset the OE_API_VERSION numbering to align with the semantic versioning to avoid this kind of confusion.