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

Define Hipcheck API evolution plan #8

Open
alilleybrinker opened this issue Apr 1, 2024 · 0 comments
Open

Define Hipcheck API evolution plan #8

alilleybrinker opened this issue Apr 1, 2024 · 0 comments
Labels
status: needs-rfd This topic is big enough to require an RFD. type: enhancement New feature or request
Milestone

Comments

@alilleybrinker
Copy link
Collaborator

Hipcheck is currently at major version 3, and thus is subject to (or at least ought to follow, to be a good open source ecosystem participant) Semantic Versioning, and avoid breaking users. At the same time, the goals for Hipcheck in 2024 involve improvements and changes to the API which will almost certainly involve deprecation of existing APIs and transition to new ones.

To achieve this, we need to define a process and associated code for handling deprecation, transition, and eventual removal of existing APIs which will no longer be supported.

The goal is for the existing APIs and the new APIs to coexist for a period, and then to have a cut-off major version break where deprecated APIs are removed. Any removal should also involve a transition plan from the old APIs to the new ones, to be documented in the Hipcheck documentation.

An RFD should be drafted which specifies Hipcheck's evolution plan, including how we will handle identifying deprecated APIs to the user, how we can guide the user to documentation for transition, and planning for eventual removal.

This is separate from identification of specific APIs which will be deprecated; it is focused solely on defining the deprecation process.

@alilleybrinker alilleybrinker added type: enhancement New feature or request status: needs-rfd This topic is big enough to require an RFD. labels Apr 1, 2024
@alilleybrinker alilleybrinker added this to the 3.4.0 milestone Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: needs-rfd This topic is big enough to require an RFD. type: enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

1 participant