Skip to content

feat(readme): migrate ReadmeCard to EntityInfoCard#366

Merged
anicke merged 1 commit into
mainfrom
feat/readme-entity-info-card-migration
May 13, 2026
Merged

feat(readme): migrate ReadmeCard to EntityInfoCard#366
anicke merged 1 commit into
mainfrom
feat/readme-entity-info-card-migration

Conversation

@anicke
Copy link
Copy Markdown
Contributor

@anicke anicke commented May 12, 2026

Summary

Migrates ReadmeCard from the legacy MUI-based InfoCard (from @backstage/core-components) to EntityInfoCard (from @backstage/plugin-catalog-react), following the same pattern adopted upstream in the main Backstage repo for catalog card components.

Changes

  • ReadmeCard now uses EntityInfoCard (BUI-based) by default, with the fullscreen icon button placed in headerActions.
  • A new ReadmeCardLegacyProps type is introduced for backward compatibility. It retains the deprecated variant and maxHeight props and continues to render using InfoCard. Users passing either prop will automatically get the legacy rendering path.
  • ReadmeCardProps is simplified to only hideIfNotFound.
  • ReadmeCardLegacyProps is exported from the package's public API.

Migration

Users who relied on variant or maxHeight don't need to change anything — the legacy props are still accepted and will use the old InfoCard rendering. The new default uses EntityInfoCard.

Checklist

  • Tests pass
  • API report updated
  • Changeset added (minorReadmeCardProps shape changed)

@anicke anicke requested a review from a team as a code owner May 12, 2026 12:33
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2026

🦋 Changeset detected

Latest commit: 66875fa

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@axis-backstage/plugin-readme Minor
app-next Patch
app Patch
backend Patch

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

@anicke anicke force-pushed the feat/readme-entity-info-card-migration branch 2 times, most recently from 3ac0bd7 to 0b41b2a Compare May 12, 2026 13:58
@anicke anicke force-pushed the feat/readme-entity-info-card-migration branch from 0b41b2a to 66875fa Compare May 12, 2026 14:02
Copy link
Copy Markdown
Contributor

@fridajac fridajac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@anicke anicke merged commit bb83b10 into main May 13, 2026
8 checks passed
@anicke anicke deleted the feat/readme-entity-info-card-migration branch May 13, 2026 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants