-
Epic
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
None
-
Create a CLI / RHDH / upstream compatibility matrix for RHDH releases
-
False
-
-
False
-
RHIDP-3966Dynamic plugins developer documentation
-
To Do
-
RHIDP-3966 - Dynamic plugins developer documentation
-
QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
-
-
EPIC Goal
Develop a version compatability matrix for RHDH, the CLI and Backstage versions that dynamic plugin authors can use when developing new dynamic plugins for RHDH.
Background/Feature Origin
Why is this important?
Dynamic plugin compatibility is based on the versioning of a lot of components, at a high level:
- The CLI version used
- The target RHDH version the plugin should be deployed to
- The Backstage interface versions that the plugin code depends on.
This issue is about collecting and documenting the versions of RHDH and Backstage packages that a dynamic plugin should use when targeting a given RHDH release. For example when targeting RHDH 1.3 you would want to use the @janus-idp/cli version 1.13.2, and probably your plugin should depend on say @backstage/core-app-api 1.14.x. Generally it would probably be good for dynamic plugin authors to align the Backstage dependencies to a version that was used at the time of a given RHDH release, we can start with the main dependencies provided by the RHDH frontend here and the RHDH backend here
User Scenarios
- as a developer I would like to know that the dependencies I choose for my dynamic plugin will be compatible with the RHDH version I plan to run it on
Dependencies (internal and external)
Acceptance Criteria
There should be a version compatibility table documented somewhere for:
- 1.3 - This should be stable
- 1.4 - These versions could be in flux leading up to the release
Maybe 1.2 could be nice to have as a stretch goal or for further validation purposes.
It may also be nice to figure out a way to generate this from package info which would help with RHIDP-4179
- is depended on by
-
RHIDP-4179 Version compatibility CLI helper tool
- New