Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-6013

Dynamic Plugin deprecations

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Normal Normal
    • 1.5.0
    • None
    • Dynamic plugins
    • None
    • Deprecations for various dynamic plugin features
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
    • Hide
      = Deprecation of legacy dynamic plugin configurations and export options

      Due to ongoing improvements in dynamic plugin functionality, the following features are deprecated and will be removed in a future release:

      - `apiFactories` configuration: Dynamic plugins should now define API factories directly within their plugin using the `createPlugin` API for better integration and maintainability.
      - `export-dynamic-plugin --embed-as-code` and `--no-embed-as-dependencies`: These options, which inline each dependency as code, have been deprecated because plugins exported this way cannot properly access the database. The `--embed-as-dependencies` option, now the default for package `export-dynamic-plugin`, replaces this behavior.
      Show
      = Deprecation of legacy dynamic plugin configurations and export options Due to ongoing improvements in dynamic plugin functionality, the following features are deprecated and will be removed in a future release: - `apiFactories` configuration: Dynamic plugins should now define API factories directly within their plugin using the `createPlugin` API for better integration and maintainability. - `export-dynamic-plugin --embed-as-code` and `--no-embed-as-dependencies`: These options, which inline each dependency as code, have been deprecated because plugins exported this way cannot properly access the database. The `--embed-as-dependencies` option, now the default for package `export-dynamic-plugin`, replaces this behavior.
    • Deprecated Functionality
    • Done

      EPIC Goal

      This epic is to collect tasks related to marking some functions of the dynamic plugin configuration or tooling as deprecated.

      Background/Feature Origin

      As the dynamic plugin technology evolves we need to ensure that we remove unused or old functionality. Some of it may be user-facing, in which case we need to document this as deprecated in a release first before removing it. Ideally we should also flag the feature as deprecated in any help text of developer documentation.

      Here is a list of items that come to mind:

      • apiFactories: This is not needed if plugin authors ensure their plugin properly adds any API factories it contains to CreatePlugin.
      • embed-as-code/no-embed-as-dependencies: this is the old dynamic plugin export method which inlines dependencies as code. Dynamic plugins exported using this method run into issues when trying to make database calls, so the new method (embed-as-dependencies) was developed and supersedes this export method.

              stlewis_2 Stan Lewis
              stlewis_2 Stan Lewis
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: