rhdh-overlay

Files (17)

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

SKILL.md (first lines)

# 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

| Outcome | Load and follow |
|---|---|
| Onboard a plugin | `workflows/onboard-plugin.md` |
| Update source version or commit | `workflows/update-plugin.md` |
| Diagnose an export or publish failure | `workflows/fix-build.md` |
| Look up a plugin version or installation artifact at a branch or tag | Follow the metadata lookup below |
| Check workspace status | `references/overlay-repo.md`, then inspect workspace files and recent `gh` runs |
| Triage the open PR backlog | `workflows/triage-prs.md`; use `scripts/triage-prs.py` for deterministic classification |
| Analyze one overlay PR | `workflows/analyze-pr.md`; use `scripts/analyze-pr.py` |
| Draft stale-PR notifications | `workflows/draft-notification.md` |
| Trigger publish | Run 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:

```bash
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.

From redhat-developer/rhdh-skills, Apache-2.0.

More from redhat-developer/rhdh-skills