feat(readme): migrate ReadmeCard to EntityInfoCard#366
Merged
Conversation
🦋 Changeset detectedLatest commit: 66875fa The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
3ac0bd7 to
0b41b2a
Compare
0b41b2a to
66875fa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates
ReadmeCardfrom the legacy MUI-basedInfoCard(from@backstage/core-components) toEntityInfoCard(from@backstage/plugin-catalog-react), following the same pattern adopted upstream in the main Backstage repo for catalog card components.Changes
ReadmeCardnow usesEntityInfoCard(BUI-based) by default, with the fullscreen icon button placed inheaderActions.ReadmeCardLegacyPropstype is introduced for backward compatibility. It retains the deprecatedvariantandmaxHeightprops and continues to render usingInfoCard. Users passing either prop will automatically get the legacy rendering path.ReadmeCardPropsis simplified to onlyhideIfNotFound.ReadmeCardLegacyPropsis exported from the package's public API.Migration
Users who relied on
variantormaxHeightdon't need to change anything — the legacy props are still accepted and will use the oldInfoCardrendering. The new default usesEntityInfoCard.Checklist
minor—ReadmeCardPropsshape changed)