mcpField
R
rhdh-plugin-export

rhdh-plugin-export

github.com/redhat-developerDevelopment1945 installsUpdated 1d ago
Repository

About rhdh-plugin-export

A skill for exporting a plugin under development into a deployable artifact from its workspace. It guides builds, packaging as an OCI image, tgz archive, or npm package, and optional registry publishing with integrity details.

Key features

  1. 01Check plugin build and TypeScript compilation
  2. 02Export plugin to dist-dynamic/
  3. 03Package as OCI image, tgz, or npm package
  4. 04Choose shared, embedded, or bundled dependencies
  5. 05Produce or verify integrity values

Use cases

  1. 01Package a locally developed plugin for deployment
  2. 02Publish an exported artifact to a registry
  3. 03Prepare an artifact reference for dynamic plugin wiring

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/redhat-developer/rhdh-skills --skill rhdh-plugin-export

After installing, type/rhdh-plugin-exportin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
examples/
dynamic-plugins.yaml
references/
export-options.md
export.md
integrity-hashes.md
packaging-formats.md
scripts/
export-plugin.py

Details

From the project README

RHDH Plugin Export

Own the step between working source and a deployable artifact. The plugin builds, exports to dist-dynamic/, gets packaged in one of three formats, and optionally lands in a registry with an integrity value the deployment can pin.

Scope against /rhdh-overlay

This skill exports a plugin you are developing, from its own workspace, on your machine. /rhdh-overlay repairs the overlay repository's CI export — source.json, plugins-list.yaml, and the export jobs that rhdh-plugin-export-overlays runs for the Extensions Catalog. If the failing export is a GitHub Actions run in that repository, it is not this skill.

Start here

  1. Confirm the plugin builds: yarn build and yarn tsc from the plugin directory.
  2. Read package.json for the plugin role, name, and version, and check that a backend plugin has a default export from src/index.ts.
  3. Decide the target format before running anything: OCI image, tgz archive, or npm package.

Route by outcome

OutcomeLoad and follow
Export and package in one passreferences/export.md; run scripts/export-plugin.py
Choose shared, embedded, or bundled dependenciesreferences/export-options.md
Compare or produce a specific artifact formatreferences/packaging-formats.md
Produce or verify an integrity valuereferences/integrity-hashes.md
See a complete deployment configurationexamples/dynamic-plugins.yaml

The bundled script covers the common path:

python scripts/export-plugin.py --plugin-dir plugins/my-plugin \
  --tag quay.io/ns/my-plugin:v0.1.0 --push --clean

Run it with --help for the full option set. Follow references/export.md step by step when the script's defaults do not fit.

Boundaries

  • This skill produces artifacts. It does not write plugin source, generate deployment configuration, or run RHDH.
  • /rhdh-plugin-authoring owns plugin source, including a missing default export or a broken build that surfaces here.
  • /rhdh-plugin-wiring owns the dynamic-plugins.yaml configuration that consumes the artifact this skill produces.
  • /rhdh-local owns installing the artifact into a running local RHDH.
  • /rhdh-overlay owns the overlay repository and the Extensions Catalog.

Invoke a named skill and describe the handoff in the conversation. Never open another skill's files.

Invariants

  • Never invent a registry reference. Derive the package name, tag, and digest from the export output and the registry response.
  • A push to a registry is an external write. Invoke the named skill mutation-gate and follow it; the operation's target is the exact registry, repository, and tag.
  • Prefer a digest over a tag when a deployment needs a stable artifact.
  • Report the produced paths and references verbatim; a deployment that pins a guessed value fails at install time, far from here.

Completion

Report the export command run, the artifact format and its exact reference or path, the shared and embedded dependency decisions, any integrity value produced, whether a push happened and to where, and the named skill to invoke next for wiring or local verification.

Comments

Markdown supported