-
Epic
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
None
-
Version compatibility CLI helper tool
-
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
Make dynamic plugin development a little bit easier by helping the user correctly align package versions through a new tool.
Background/Feature Origin
Why is this important?
Often a dynamic plugin can fail to load because it's pulling in an upstream dependency that is incompatible with the RHDH application shell, or perhaps using a version of the @janus-idp/cli or @backstage/cli tool that is not intended for that RHDH version.
User Scenarios
- As a user I want to be confident that I am using the correct dependencies for my dynamic plugin so it will load properly into RHDH
- As a user I may a tool that helps me discover some transitive dependency that could be causing problems.
Dependencies (internal and external)
Acceptance Criteria
The CLI tool should at least:
- report the current plugin project's dependencies, including transitive dependencies
- highlight dependencies that are sufficiently different from the target RHDH release
Release Enablement/Demo - Provide necessary release enablement details
and documents
DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
Issue>
DEV - Upstream documentation merged: <link to meaningful PR or GitHub
Issue>
DEV - Downstream build attached to advisory: <link to errata>
QE - Test plans in Playwright: <link or reference to playwright>
QE - Automated tests merged: <link or reference to automated tests>
DOC - Downstream documentation merged: <link to meaningful PR>
- depends on
-
RHIDP-4172 Create a CLI / RHDH / upstream compatibility matrix for RHDH releases
- New