[Meta] Stabilize API for v3.0.0

[Adirio]

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

• Latest v3 API
• v3.0.0-beta.0 API

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:

  • Remove unexported references in documentation:
    *cli is being mentioned in this package's documentation.
    • Issue: Removing unexported type cli from documentation in pkg.go.dev #2078
    • Implementation: 🌱 Remove CLI interface and expose cli instead #2079
  • WithCompletion signature:
    Modify the signature in order to reflect that it is an Option.
    • Issue: Convert WithCompletion into a cli.Option #2044
    • Implementation: ⚠️ Explicitly define WithCompletion as an Option #2045

• pkg/config

  • Config interface:
    Extract the plugin related logic out of the Config interface implementations.
    • Issue: Final Config interface for v3.0.0 #2046
    • Implementation: ⚠️ Decouple plugin requirements from Config interface #2047
  • Register signature:
    Remove the unexported constructorFunc alias for func() Config.
    • Implementation: 🌱 Fix the config registry public API #2072

• 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.

  • Needed for: ✨ Export scaffolding machinery #2036, ✨ Export config file schafolding machinery #2056
  • Internal utility functions: 🌱 Move the internal machinery utils to appropiate exported packages #2074
  • Single filesystem abstraction: ⚠️ Inject filesystem from CLI instead of creating several per command #2080
  • Export scaffolding machinery: ⚠️ Export scaffolding machinery #2082
  • Export config persistence machinery: 🌱 Export config machinery #2083

• Phase 1.5 plugin API:
  The API changes in this phase include a different set of subcommand-hooks to enable plugin chaining.

  • Design document
  • Design update: 📖 Improve plugin phase 1.5 EP #2075
  • Implementation: ⚠️ Plugin phase 1.5 implementation #2060

[camilamacedo86]

Hi @Adirio,

I think we are talking here about we address all the next plugin changes described in #2016 before the plugin 2.0 proposal.

[Adirio]

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.

[Adirio]

All points have been tackled, closing. If any other arises reopen.