agentleFS
redhat-developerredhat-developer/rhdh-skills/skills/plugins/rhdh-plugin-nfs-migration/SKILL.md

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.

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
  1. Very specific:

    Read the plugin's package.json, src/plugin.ts or src/plugin.tsx, route refs, API factories, exported components, and …

    line 27
  2. Distinctive:

    Read the workspace's own AGENTS.md or CLAUDE.md.

    line 29
  3. Very specific:

    Keep component-level imports (useApi, useRouteRef) on @backstage/core-plugin-api so the same components serve both export paths.

    line 84
  4. Very specific:

    Put entity content and cards directly in the plugin's extensions array.

    line 92
  5. Very specific:

    Use createFrontendModule only to target a different plugin — translations at pluginId: 'app', homepage widgets at pluginId: 'home'.

    line 93
  6. Very specific:

    Run yarn tsc from the workspace root, not the plugin directory, so consumer import breakage surfaces.

    line 97
  7. Distinctive:

    Do not stage, commit, push, or open a pull request here.

    line 99

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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

  1. Read the plugin's package.json, src/plugin.ts or src/plugin.tsx, route refs, API factories, exported components, and app-config.dynamic.yaml.
  2. Read the workspace's own AGENTS.md or CLAUDE.md; repository rules beat anything written here.
  3. List every discovered extension to the user before editing.
  4. Inspect branch and status before modifying files, and protect uncommitted work.

Route by outcome

OutcomeLoad and follow
Migrate a plugin to NFSworkflows/migrate-nfs.md
Test a migrated plugin in RHDHworkflows/test-nfs-plugin.md
Explain NFS before migratingreferences/overview.md
Migrate pages or API factoriesreferences/migrate-page.md
Migrate entity tabs or cardsreferences/migrate-entity-content.md
Migrate translationsreferences/migrate-translations.md
Migrate RHDH drawers, header items, homepage widgetsreferences/migrate-rhdh-extensions.md
Migrate app-level wrappers or root elementsreferences/migrate-app-level.md
Translate a legacy dynamic mount point into an extensionreferences/mount-point-mapping.md
Update package exportsreferences/package-json.md
Set up or update the NFS dev appreferences/app-setup.md
Verify the migrationreferences/verification.md
Reach RHDH operator app.extensions or app.routes.bindingsreferences/operator-config.md
Troubleshoot a failed migrationreferences/gotchas.md, then references/support.md
Find a real migrated plugin to copyreferences/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-upgrade owns 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-changes owns the NFS API deltas between the early alpha and the current GA surface — removed NavItemBlueprint, the configSchema replacement for config.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-export owns exporting and packaging the migrated plugin.
  • /rhdh-plugin-wiring owns generating dynamic-plugins.yaml configuration.
  • /rhdh-local owns running a local RHDH instance and applying plugin configuration to it.
  • /rhdh-pr-create owns 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-api so the same components serve both export paths. Reach for compatWrapper() 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 as AppDrawerContentBlueprint and GlobalHeaderMenuItemBlueprint come from @red-hat-developer-hub/*. Do not mix the two namespaces.
  • Put entity content and cards directly in the plugin's extensions array. Use createFrontendModule only to target a different plugin — translations at pluginId: 'app', homepage widgets at pluginId: 'home'.
  • Legacy exports stay available. A breaking change to a legacy consumer needs explicit user approval.
  • Run yarn tsc from 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.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.