mcpField
R
rhdh-overlay

rhdh-overlay

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

About rhdh-overlay

A workflow skill for maintaining plugin catalog packaging and overlay-repository operations in redhat-developer/rhdh-plugin-export-overlays. It routes onboarding, metadata updates, build troubleshooting, PR analysis, and guarded publishing through repository-specific procedures.

Key features

  1. 01Plugin onboarding and updates
  2. 02Overlay metadata lookup
  3. 03Export and publish failure diagnosis
  4. 04Workspace and CI status checks
  5. 05PR triage and analysis
  6. 06Guarded publish procedure

Use cases

  1. 01Onboard a plugin in an overlay workspace
  2. 02Look up plugin package versions and artifacts
  3. 03Investigate export or publish failures
  4. 04Review overlay PRs and workspace status

Install

Copy the command and run it in a terminal.

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

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

Bundled files

References and scripts installed along with SKILL.md.

agents/
openai.yaml
references/
ci-feedback.md
label-priority.md
metadata-format.md
overlay-repo.md
rhdh-local.md
scripts/
analyze-pr.py
triage-prs.py
templates/
workspace-files.md
workflows/
analyze-pr.md
doctor.md
draft-notification.md
fix-build.md
onboard-plugin.md
triage-prs.md
update-plugin.md

Details

From the project README

RHDH Overlay

Own catalog packaging and overlay-repository operations. Work from a checkout whose remote identifies redhat-developer/rhdh-plugin-export-overlays; do not depend on another installed skill's files or CLI.

Start here

  1. Read repository instructions and run gh auth status.
  2. Confirm the checkout and remote with git remote -v.
  3. Inspect the target workspace, a similar workspace, and the relevant PR or CI logs before changing metadata.
  4. For environment problems, follow workflows/doctor.md.

Route by outcome

OutcomeLoad and follow
Onboard a pluginworkflows/onboard-plugin.md
Update source version or commitworkflows/update-plugin.md
Diagnose an export or publish failureworkflows/fix-build.md
Look up a plugin version or installation artifact at a branch or tagFollow the metadata lookup below
Check workspace statusreferences/overlay-repo.md, then inspect workspace files and recent gh runs
Triage the open PR backlogworkflows/triage-prs.md; use scripts/triage-prs.py for deterministic classification
Analyze one overlay PRworkflows/analyze-pr.md; use scripts/analyze-pr.py
Draft stale-PR notificationsworkflows/draft-notification.md
Trigger publishRun the guarded publish procedure below

Infer a clear route. Ask only for a missing plugin, workspace, source ref, or PR number that cannot be discovered from the checkout.

Metadata lookup

Use the requested overlay branch or tag, defaulting to main, for every read. Read catalog-entities/extensions/plugins/<plugin-name>.yaml at that ref, resolve spec.packages, then locate each Package entity in the workspace's metadata/ directory at the same ref. Report spec.packageName, spec.version, and spec.dynamicArtifact from those entities. Use git show <ref>:<path> in the overlay checkout; report a missing ref or metadata instead of falling back to main. Read references/metadata-format.md for the entity fields.

Invariants

  • Every export is configured in the overlay repository; CI performs the export.
  • source.json repo-backstage-version is the upstream source's actual Backstage version. backstage.json version is the RHDH compatibility override. Never substitute one for the other.
  • Derive packages and refs from upstream and generated metadata; never invent an OCI URL.
  • Copy the structure of a current, similar workspace when repository conventions differ from this skill's examples.
  • Before merge, test the exact PR artifact. Authentication errors from an otherwise loaded plugin may be acceptable; installation or boot errors are not.

Guarded publish

Before posting /publish, verify the PR is open, lacks do-not-merge, and has no successful publish check for the current head. Posting the comment is an external write: invoke the named skill mutation-gate and follow the gate it owns rather than restating it here.

State one operation. Its target is redhat-developer/rhdh-plugin-export-overlays#<number>@<head-sha>, its preview body is /publish, its preconditions are those three checks, and on failure it reports the comment for manual removal if the trigger was wrong. Only after the user approves that stated operation, run:

gh pr comment <number> --repo redhat-developer/rhdh-plugin-export-overlays --body "/publish"

Report the comment and publish-check URLs, or the failure and what recovery it needs. A request to trigger publication is intent to read the PR, not approval of this write.

Other external writes

The same gate covers every push, PR creation, notification, or other external write a workflow reaches. State operations only once targets and payloads are exact, run nothing absent from the approved set, and report an outcome for every operation including the ones that were skipped. Read-only triage and analysis need no gate.

What a caller supplies

A caller invokes this skill by name and states the source repository, the source ref (commit or tag), the packages, the upstream Backstage version, and the target RHDH version.

What this skill reports

  • the workspace, and what changed in it: source ref, packages, metadata files
  • CI and local verification evidence, with skipped checks and their reasons
  • the pull request URL, or that none was opened
  • publish status: not requested, pending, passed, or failed
  • the outcome of every approved external write
  • remaining compatibility risks

For local verification, invoke /rhdh-local by name and give it the exact artifact references, plugin config, named environment variables, and checks to run. Do not load the local skill's files.

Completion

Complete when the report covers workspace and metadata changes, commands and scripts run, CI and local verification evidence, the outcome of every approved write, publish status, and remaining compatibility risks.

Comments

Markdown supported