-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
[Meta] Stabilize API for v3.0.0 #2043
Comments
This tracks the ones that are breaking API-wise. If they just add something to the API they can wait for v3.1.0 but if they break the current API they need to be addressed before v3.0.0. This tracks exactly the breaking changes. |
All points have been tackled, closing. If any other arises reopen. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Purpose
This Issue will track all the API changes that are considered needed before we can continue with the v3.0.0 release. It only considers breaking changes, adding new exposed APIs can be done in minor/patch releases and therefore do not block the v3.0.0 release.
Being the first release where kubebuilder is considered a library, reviewing the exported API and checking that it is exactly what we want is specially important as v3.X releases will have to offer backwards compatibility related to this API.
Useful links
API changes
The list of plugins here are listed in no particular order.
If you find any other change that you consider that should be included, add a comment.
pkg/cli
:*cli
is being mentioned in this package's documentation.WithCompletion
signature:Modify the signature in order to reflect that it is an
Option
.pkg/config
Config
interface:Extract the plugin related logic out of the
Config
interface implementations.Register
signature:Remove the unexported
constructorFunc
alias forfunc() Config
.Export internal machinery:
In order to export the internal machinery for the project configuration file and for the project scaffolding, a single filesystem abstraction should be used instead of multiple.
Phase 1.5 plugin API:
The API changes in this phase include a different set of subcommand-hooks to enable plugin chaining.
The text was updated successfully, but these errors were encountered: