rhdh-plugin-nfs-migration
Skill20 starsChanged 20 days agoApache-2.0View on GitHub
Converts a legacy Backstage frontend plugin used by Red Hat Developer Hub to the New Frontend System (NFS): replace createPlugin and createRoutableExtension with createFrontendPlugin, PageBlueprint, EntityContentBlueprint, AppDrawerContentBlueprint and createFrontendModule; map RHDH app-config.dynamic.yaml mount points onto extensions; add the ./alpha export to package.json without breaking legacy consumers; and verify the migrated dynamic plugin in a real RHDH instance. Use for "migrate my plugin to NFS", Blueprint migration, createFrontendPlugin, compatWrapper, alpha versus colocated exports, translations moved into a createFrontendModule with pluginId app, RHDH operator app.extensions and app.routes.bindings, and ENABLE_STANDARD_MODULE_FEDERATION testing.
In this repository73 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- rhdh-base-imagesSkill
- rhdh-konflux-rpaSkill
- rhdh-konflux-tasksSkill
- rhdh-plugin-catalog-index-status-and-update-flowSkill
- rhdh-pr-mrSkill
- rhdh-prow-jobsSkill
- rhdh-prow-release-branchSkill
- rhdh-prow-triggerSkill
- rhdh-yarn-bumpSkill
- rhdh-feature-docsSkill
- rhdh-jira-createSkill
- rhdh-jira-linkSkill
- rhdh-jira-refineSkill
- rhdh-jira-sprint-planSkill
- rhdh-jira-sprint-reportSkill
- rhdh-jira-updateSkill
- rhdh-prepare-refinementSkill
- agent-readinessSkill
- ask-rhdhSkill
- clean-proseSkill
- setup-rhdh-skillsSkill
- skill-authoringSkill
- rhdh-backportSkill
- rhdh-backstage-upgradeSkill
- rhdh-localSkill
- rhdh-operator-pr-testSkill
- rhdh-overlaySkill
- rhdh-playwrightSkill
- rhdh-plugin-authoringSkill
- rhdh-plugin-bug-fixSkill
- rhdh-plugin-exportSkill
- rhdh-plugin-midstream-propagateSkill
- rhdh-plugin-wiringSkill
- rhdh-pr-createSkill
- rhdh-pr-reviewSkill
- rhdh-test-placementSkill
- backstage-api-changesSkill
- mutation-gateSkill
- openspec-journalSkill
- prose-editingSkill
- rhdh-contextSkill
- rhdh-forgeSkill
- rhdh-jira-apiSkill
- rhdh-jira-authoringSkill
- rhdh-spec-driven-schemaSkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-audit-changeSkill
- openspec-bulk-archive-changeSkill
- openspec-continue-changeSkill
- openspec-exploreSkill
- openspec-ff-changeSkill
- openspec-new-changeSkill
- openspec-onboardSkill
- openspec-sync-specsSkill
- openspec-verify-changeSkill
- rhdh-overlay-cve-exportSkill
- rhdh-platform-lifecycleSkill
- The first 60 shown.
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 2 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 27
Read the plugin's package.json, src/plugin.ts or src/plugin.tsx, route refs, API factories, exported components, and …
- Distinctive: line 29
Read the workspace's own AGENTS.md or CLAUDE.md.
- Very specific: line 84
Keep component-level imports (useApi, useRouteRef) on @backstage/core-plugin-api so the same components serve both export paths.
- Very specific: line 92
Put entity content and cards directly in the plugin's extensions array.
- Very specific: line 93
Use createFrontendModule only to target a different plugin — translations at pluginId: 'app', homepage widgets at pluginId: 'home'.
- Very specific: line 97
Run yarn tsc from the workspace root, not the plugin directory, so consumer import breakage surfaces.
- Distinctive: line 99
Do not stage, commit, push, or open a pull request here.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
RHDH Plugin NFS Migration
Own the shape of a frontend plugin's extensions as it moves from the legacy frontend system to NFS. Discover what the plugin exports before changing anything, migrate one extension type at a time, and keep legacy consumers compiling until the user explicitly approves a breaking change.
Start here
- Read the plugin's
package.json,src/plugin.tsorsrc/plugin.tsx, route refs, API factories, exported components, andapp-config.dynamic.yaml. - Read the workspace's own
AGENTS.mdorCLAUDE.md; repository rules beat anything written here. - List every discovered extension to the user before editing.
- Inspect branch and status before modifying files, and protect uncommitted work.
Route by outcome
| Outcome | Load and follow |
| Migrate a plugin to NFS | workflows/migrate-nfs.md |
| Test a migrated plugin in RHDH | workflows/test-nfs-plugin.md |
| Explain NFS before migrating | references/overview.md |
| Migrate pages or API factories | references/migrate-page.md |
| Migrate entity tabs or cards | references/migrate-entity-content.md |
| Migrate translations | references/migrate-translations.md |
| Migrate RHDH drawers, header items, homepage widgets | references/migrate-rhdh-extensions.md |
| Migrate app-level wrappers or root elements | references/migrate-app-level.md |
| Translate a legacy dynamic mount point into an extension | references/mount-point-mapping.md |
| Update package exports | references/package-json.md |
| Set up or update the NFS dev app | references/app-setup.md |
| Verify the migration | references/verification.md |
Reach RHDH operator app.extensions or app.routes.bindings | references/operator-config.md |
| Troubleshoot a failed migration | references/gotchas.md, then references/support.md |
| Find a real migrated plugin to copy | references/reference-prs.md |
Boundaries
- This skill owns extension shape: which Blueprint replaces which legacy
extension, where it attaches, and what the package exports. It does not
choose
@backstage/*version numbers. /rhdh-backstage-upgradeowns version numbers: which Backstage release to move to and how to get the dependency set there. When the plugin's@backstage/*dependencies are too old for the Blueprints this migration needs, invoke it by name first, then return here./backstage-api-changesowns the NFS API deltas between the early alpha and the current GA surface — removedNavItemBlueprint, theconfigSchemareplacement forconfig.schema, renamed blueprint params. Invoke it by name when migrating a plugin that was already migrated against an older NFS API, or when a Blueprint param produces a TypeScript error./rhdh-plugin-exportowns exporting and packaging the migrated plugin./rhdh-plugin-wiringowns generatingdynamic-plugins.yamlconfiguration./rhdh-localowns running a local RHDH instance and applying plugin configuration to it./rhdh-pr-createowns staging, commits, and pull requests. Leave changed files unstaged and list them when you finish.
Invoke a named skill and describe the handoff in the conversation. Never open another skill's files.
Invariants
- NFS is not GA. Default to the alpha approach: NFS at
./alpha, legacy untouched at the root export. Use the colocated approach only when the user wants both APIs from one import path. - Keep component-level imports (
useApi,useRouteRef) on@backstage/core-plugin-apiso the same components serve both export paths. Reach forcompatWrapper()only when a component needs a legacy context provider that NFS does not supply. - Core blueprints come from
@backstage/frontend-plugin-api. RHDH-only blueprints such asAppDrawerContentBlueprintandGlobalHeaderMenuItemBlueprintcome from@red-hat-developer-hub/*. Do not mix the two namespaces. - Put entity content and cards directly in the plugin's
extensionsarray. UsecreateFrontendModuleonly to target a different plugin — translations atpluginId: 'app', homepage widgets atpluginId: 'home'. - Legacy exports stay available. A breaking change to a legacy consumer needs explicit user approval.
- Run
yarn tscfrom the workspace root, not the plugin directory, so consumer import breakage surfaces. - Do not stage, commit, push, or open a pull request here.
Completion
Report the extensions discovered and their NFS equivalents, the export approach chosen, the files changed and left unstaged, the verification commands run and their results, any legacy consumer risk, and the named skill to invoke next for export, wiring, local testing, or publication.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

