Back to Details

rhdh

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<cli_setup> Locate and set the CLI variable:
The CLI script is at 
scripts/rhdh
relative to this SKILL.md file (not the working directory).
When you read this file, note its path and derive the script location:
  • If SKILL.md is at 
    /path/to/skills/rhdh/SKILL.md
  • Then the CLI is at 
    /path/to/skills/rhdh/scripts/rhdh
bash
RHDH="/path/to/skills/rhdh/scripts/rhdh"  # Use the actual path
Get oriented (run first):
bash
$RHDH
This shows environment status, discovered repos, and available tools. </cli_setup>
<essential_principles>
<principle name="track_activity"> Use `$RHDH log` and `$RHDH todo` to maintain context across sessions. Log milestones with tags. Create todos when blocked on external input. This enables resuming work without re-explaining context and builds an audit trail. See the `<tracking_system>` section for details. </principle> <principle name="consult_tool_references"> **Before using GitHub CLI**, read the reference file: - **GitHub:** `references/github-reference.md` — PR queries, CI analysis, `/publish` triggers
Contains critical gotchas (jq escaping, assignee format) that prevent common errors. </principle>
<principle name="understand_rhdh_repos"> **Before any RHDH-related work**, consult `references/rhdh-repos.md` for a reference of all RHDH-related repositories, what each one is used for, and how they relate to each other. Use this when navigating between projects or understanding the overall RHDH ecosystem. Use `$RHDH config set` to set the path to the local checkout of the RHDH repositories. </principle>
</essential_principles>
<context_scan> Run on invocation to understand current state:
bash
$RHDH
This checks:
  • Overlay repo location and status
  • rhdh-local availability
  • gh CLI authentication
  • Container runtime (podman/docker)
If repos not found: Run 
$RHDH config init
to auto-detect or configure paths. </context_scan>
<intake>
<cli_setup> 定位并设置CLI变量：
CLI脚本位于相对于本SKILL.md文件的
scripts/rhdh
路径下（而非工作目录）。
当你读取本文件时，请记录其路径并推导脚本位置：
  • 如果SKILL.md位于
    /path/to/skills/rhdh/SKILL.md
  • 那么CLI位于
    /path/to/skills/rhdh/scripts/rhdh
bash
RHDH="/path/to/skills/rhdh/scripts/rhdh"  # 使用实际路径
快速了解环境（首次运行）：
bash
$RHDH
此命令会显示环境状态、已发现的仓库以及可用工具。 </cli_setup>
<essential_principles>
<principle name="track_activity"> 使用`$RHDH log`和`$RHDH todo`来跨会话维护上下文。 使用标签记录里程碑。当因外部输入受阻时创建待办事项。 这使得无需重新解释上下文即可恢复工作，并构建审计跟踪。 详情请参见`<tracking_system>`部分。 </principle> <principle name="consult_tool_references"> **在使用GitHub CLI之前**，请阅读参考文件： - **GitHub：** `references/github-reference.md` — PR查询、CI分析、`/publish`触发器
其中包含防止常见错误的关键注意事项（jq转义、经办人格式）。 </principle>
<principle name="understand_rhdh_repos"> **在进行任何RHDH相关工作之前**，请查阅`references/rhdh-repos.md`获取所有RHDH相关仓库的参考信息，包括每个仓库的用途以及它们之间的关系。 在项目间导航或了解整体RHDH生态系统时使用此参考。 使用`$RHDH config set`设置RHDH仓库本地检出的路径。 </principle>
</essential_principles>
<context_scan> 调用时运行以了解当前状态：
bash
$RHDH
此命令会检查：
  • 覆盖层仓库的位置和状态
  • rhdh-local的可用性
  • gh CLI的认证状态
  • 容器运行时（podman/docker）
**如果未找到仓库：**运行
$RHDH config init
自动检测或配置路径。 </context_scan>
<intake>

Step 1: Run CLI

步骤1：运行CLI

bash
$RHDH
If 
needs_setup: true
: Stop and run 
$RHDH doctor
to fix setup issues.
bash
$RHDH
**如果输出显示
needs_setup: true
：**停止操作并运行
$RHDH doctor
修复设置问题。

Step 2: Identify Task Type

步骤2：识别任务类型

What would you like to do?
你想要执行什么操作？

Overlay Repository Tasks

覆盖层仓库任务

For working with the rhdh-plugin-export-overlays repository
  1. Onboard a new plugin — Add upstream plugin to Extensions Catalog
  2. Update plugin version — Bump to newer upstream commit/tag
  3. Fix build failure — Debug CI/publish issues
  4. Triage overlay PRs — Prioritize open PRs by criticality
  5. Analyze specific PR — Check assignment, compatibility, merge readiness
用于处理rhdh-plugin-export-overlays仓库
  1. 接入新插件 — 将上游插件添加到扩展目录
  2. 更新插件版本 — 升级到较新的上游提交/标签
  3. 修复构建失败 — 调试CI/发布问题
  4. 分类覆盖层PR — 按优先级排序未处理的PR
  5. 分析特定PR — 检查分配情况、兼容性、合并就绪状态

Plugin Creation Tasks

插件创建任务

For creating new RHDH dynamic plugins from scratch
  1. Create plugin — Bootstrap, export, package, or wire a dynamic plugin (backend or frontend)
用于从头创建新的RHDH动态插件
  1. 创建插件 — 初始化、导出、打包或连接动态插件（后端或前端）

Local Testing Tasks

本地测试任务

For testing plugins in a local RHDH instance using rhdh-local-setup
  1. Local testing — Enable/disable/test plugins in local RHDH
用于使用rhdh-local-setup在本地RHDH实例中测试插件
  1. 本地测试 — 在本地RHDH中启用/禁用/测试插件

Review & Testing Tasks

评审与测试任务

For testing PR changes on a live RHDH cluster
  1. Review operator PR — Deploy PR operator bundle on cluster and get review checklist
用于在实时RHDH集群上测试PR变更
  1. 评审Operator PR — 在集群上部署PR Operator包并获取评审清单

Test Plan Tasks

测试计划任务

For rhdh test plan review in jira
  1. Review Test Plan content — Reviews an RHDH test plan Jira ticket and suggests platform/integration version updates based on support lifecycle pages and RHDH release milestones
用于在Jira中评审RHDH测试计划
  1. 评审测试计划内容 — 评审RHDH测试计划Jira工单，并根据支持生命周期页面和RHDH发布里程碑建议平台/集成版本更新

General Tasks

常规任务

  1. Check environment — Run doctor, configure paths
  2. View/search activity — Review worklog, todos
Wait for response before proceeding. </intake>
<routing>
  1. 检查环境 — 运行doctor命令、配置路径
  2. 查看/搜索活动 — 查看工作日志、待办事项
等待响应后再继续。 </intake>
<routing>

Doctor Route (Priority)

Doctor路由（优先级）

ConditionAction
needs_setup: true
in CLI output		Run 
$RHDH doctor
Always check this first.
条件操作
CLI输出中包含
needs_setup: true
运行
$RHDH doctor
请始终首先检查此项。

Overlay Repository Routes

覆盖层仓库路由

ResponseSkill
1-5, "onboard", "update", "fix", "triage", "PR", "overlay", "plugin", "workspace"Route to 
@overlay
skill
To route: Read 
../overlay/SKILL.md
and follow its intake process.
响应技能
1-5、"onboard"、"update"、"fix"、"triage"、"PR"、"overlay"、"plugin"、"workspace"路由到
@overlay
技能
**路由方式：**阅读
../overlay/SKILL.md
并遵循其接入流程。

Plugin Creation Routes

插件创建路由

ResponseSkill
6, "backend plugin", "create backend", "frontend plugin", "create frontend", "export", "package", "OCI", "publish plugin", "wiring", "mount points", "routes", "entity tabs"Route to 
@create-plugin
skill
To route: Read 
../create-plugin/SKILL.md
and follow its routing rules (backend, frontend, export, wiring sub-commands).
响应技能
6、"backend plugin"、"create backend"、"frontend plugin"、"create frontend"、"export"、"package"、"OCI"、"publish plugin"、"wiring"、"mount points"、"routes"、"entity tabs"路由到
@create-plugin
技能
**路由方式：**阅读
../create-plugin/SKILL.md
并遵循其路由规则（后端、前端、导出、连接子命令）。

Local Testing Routes

本地测试路由

ResponseSkill
7, "local", "test locally", "enable plugin", "disable plugin", "local testing", "rhdh-local-setup"Route to 
@rhdh-local
skill
To route: Read 
../rhdh-local/SKILL.md
and follow its intake process.
响应技能
7、"local"、"test locally"、"enable plugin"、"disable plugin"、"local testing"、"rhdh-local-setup"路由到
@rhdh-local
技能
**路由方式：**阅读
../rhdh-local/SKILL.md
并遵循其接入流程。

Review & Testing Routes

评审与测试路由

ResponseSkill
8, "review PR", "code review", "PR review", "test PR", "operator PR", "review this PR", "rhdh-pr-review"Route to 
@rhdh-pr-review
skill
To route: Read 
../rhdh-pr-review/SKILL.md
and follow its intake process.
响应技能
8、"review PR"、"code review"、"PR review"、"test PR"、"operator PR"、"review this PR"、"rhdh-pr-review"路由到
@rhdh-pr-review
技能
**路由方式：**阅读
../rhdh-pr-review/SKILL.md
并遵循其接入流程。

Test Plan Routes

测试计划路由

ResponseSkill
9, "review test plan", "update test plan", "check platform versions in test plan", "review RHDH test plan"Route to 
@rhdh-test-plan-review
skill
To route: Read 
../rhdh-test-plan-review/SKILL.md
and follow its intake process.
响应技能
9、"review test plan"、"update test plan"、"check platform versions in test plan"、"review RHDH test plan"路由到
@rhdh-test-plan-review
技能
**路由方式：**阅读
../rhdh-test-plan-review/SKILL.md
并遵循其接入流程。

General Routes

常规路由

ResponseAction
10, "doctor", "setup", "config"Use CLI commands below
11, "log", "todo", "activity"Use tracking commands below
</routing>
<cli_commands> Environment status (no args):
bash
$RHDH
Shows overlay repo, rhdh-local, tools status, and next steps.
Full environment check:
bash
$RHDH doctor
Configuration:
bash
$RHDH config init                  # Create config with auto-detection
$RHDH config show                  # Show resolved paths
$RHDH config set overlay /path     # Set rhdh-plugin-export-overlays location
$RHDH config set local /path       # Set rhdh-local location
$RHDH config set rhdh /path        # Set main rhdh repo location
$RHDH config set downstream /path  # Set rhdh-downstream location
$RHDH config set cli /path         # Set rhdh-cli location
$RHDH config set plugins /path     # Set rhdh-plugins location
$RHDH config set operator /path    # Set rhdh-operator location
$RHDH config set chart /path       # Set rhdh-chart location
$RHDH config set catalog /path     # Set rhdh-plugin-catalog location
Workspace operations:
bash
$RHDH workspace list           # List all plugin workspaces
$RHDH workspace status <name>  # Show workspace details
</cli_commands>
<tracking_system>
响应操作
10、"doctor"、"setup"、"config"使用下方的CLI命令
11、"log"、"todo"、"activity"使用下方的跟踪命令
</routing>
<cli_commands> 环境状态（无参数）：
bash
$RHDH
显示覆盖层仓库、rhdh-local、工具状态以及下一步操作建议。
完整环境检查：
bash
$RHDH doctor
配置命令：
bash
$RHDH config init                  # 通过自动检测创建配置
$RHDH config show                  # 显示解析后的路径
$RHDH config set overlay /path     # 设置rhdh-plugin-export-overlays的位置
$RHDH config set local /path       # 设置rhdh-local的位置
$RHDH config set rhdh /path        # 设置主rhdh仓库的位置
$RHDH config set downstream /path  # 设置rhdh-downstream的位置
$RHDH config set cli /path         # 设置rhdh-cli的位置
$RHDH config set plugins /path     # 设置rhdh-plugins的位置
$RHDH config set operator /path    # 设置rhdh-operator的位置
$RHDH config set chart /path       # 设置rhdh-chart的位置
$RHDH config set catalog /path     # 设置rhdh-plugin-catalog的位置
工作区操作：
bash
$RHDH workspace list           # 列出所有插件工作区
$RHDH workspace status <name>  # 显示工作区详情
</cli_commands>
<tracking_system>

Activity Tracking (Recommended)

活动跟踪（推荐）

The CLI includes worklog and todo tracking to maintain context across sessions. Use is recommended but not required.
CLI包含工作日志和待办事项跟踪功能，用于跨会话维护上下文。建议使用，但非强制要求。

Why Track?

为什么要跟踪？

  • Cross-session memory — Pick up where you left off without re-explaining context
  • Audit trail — "When did we onboard X?" / "What happened with PR #123?"
  • Follow-up reminders — Don't lose track of blocked items waiting on external input
  • 跨会话记忆 — 无需重新解释上下文即可从中断处继续工作
  • 审计跟踪 — 回答“我们何时接入了X？” / “PR #123的情况如何？”这类问题
  • 跟进提醒 — 不会遗漏等待外部输入的受阻事项

Worklog Commands

工作日志命令

Append-only activity log stored in 
.rhdh/worklog.jsonl
:
bash
undefined
追加式活动日志存储在
.rhdh/worklog.jsonl
中：
bash
undefined

Log activity with tags for searchability

使用标签记录活动以便搜索

$RHDH log add "Started onboard: aws-appsync" --tag onboard --tag aws-appsync $RHDH log add "PR #1234 merged" --tag aws-appsync --tag pr
$RHDH log add "Started onboard: aws-appsync" --tag onboard --tag aws-appsync $RHDH log add "PR #1234 merged" --tag aws-appsync --tag pr

View recent entries

查看最近的条目

$RHDH log show --limit 10
$RHDH log show --limit 10

Search past activity

搜索过往活动

$RHDH log search "aws-appsync" $RHDH log search "onboard"
undefined
$RHDH log search "aws-appsync" $RHDH log search "onboard"
undefined

Todo Commands

待办事项命令

Section-based markdown todos stored in 
.rhdh/TODO.md
:
bash
undefined
基于章节的Markdown待办事项存储在
.rhdh/TODO.md
中：
bash
undefined

Create todo when blocked

当工作受阻时创建待办事项

$RHDH todo add "Check license with legal" --context "aws-appsync" $RHDH todo add "Follow up on stale PR #1234" --context "triage"
$RHDH todo add "Check license with legal" --context "aws-appsync" $RHDH todo add "Follow up on stale PR #1234" --context "triage"

List and manage

列出并管理待办事项

$RHDH todo list # All todos $RHDH todo list --pending # Only open items
$RHDH todo list # 所有待办事项 $RHDH todo list --pending # 仅未完成项

Update progress

更新进度

$RHDH todo note <slug> "Sent email to legal@redhat.com" $RHDH todo done <slug>
$RHDH todo note <slug> "Sent email to legal@redhat.com" $RHDH todo done <slug>

View raw file

查看原始文件

$RHDH todo show
undefined
$RHDH todo show
undefined

When to Track

何时跟踪？

Log these milestones:
  • Starting/completing a workflow (onboard, update, triage)
  • PR actions (opened, published, merged)
  • Significant decisions or findings
Create todos for:
  • Blocked items waiting on external response (legal, upstream, team)
  • Post-merge follow-ups (verify in staging, remove workarounds)
  • Items that span multiple sessions
记录以下里程碑：
  • 工作流的开始/完成（接入、更新、分类）
  • PR操作（创建、发布、合并）
  • 重要决策或发现
为以下情况创建待办事项：
  • 等待外部响应（法务、上游、团队）的受阻事项
  • 合并后的跟进工作（在预发布环境验证、移除临时方案）
  • 跨多个会话的事项

Writing Effective Todos

编写有效的待办事项

Todos must be self-contained—a new session should understand the task without re-investigating.
❌ Too vague✅ Actionable
Fix #1875 version mismatchFix #1875 (lightspeed): bump 
1.3.0→1.4.0
in 
workspace.yaml
like #1903
Add /ok-to-test to #1921Add /ok-to-test to #1921 (techdocs) — smoke tests ready, needs external trigger
Review #1906 SonarCloudReview #1906 (catalog): SonarCloud blocked on coverage — check if test file missing
Include: PR number, plugin name, specific action, and why it's needed.
</tracking_system>
<reference_index> RHDH Repos: references/rhdh-repos.md — repository map, ecosystem relationships, key paths GitHub CLI (PRs, CI, workflows): references/github-reference.md Version Matrix: references/versions.md — RHDH/Backstage version compatibility, create-app versions Slack Notifications: references/slack-notification.md — Slack ping templates, handle mapping, channel routing </reference_index>
<skills_index>
待办事项必须独立完整——新会话无需重新调查即可理解任务。
❌ 过于模糊✅ 可执行
Fix #1875 version mismatch修复#1875（lightspeed）：像#1903一样在
workspace.yaml
中将版本从
1.3.0
升级到
1.4.0
Add /ok-to-test to #1921为#1921（techdocs）添加/ok-to-test标签——冒烟测试已就绪，需要外部触发
Review #1906 SonarCloud评审#1906（catalog）：SonarCloud因覆盖率问题受阻——检查是否缺少测试文件
**请包含：**PR编号、插件名称、具体操作以及原因。
</tracking_system>
<reference_index> RHDH仓库： references/rhdh-repos.md — 仓库映射、生态系统关系、关键路径 GitHub CLI（PR、CI、工作流）： references/github-reference.md 版本矩阵： references/versions.md — RHDH/Backstage版本兼容性、create-app版本 Slack通知： references/slack-notification.md — Slack ping模板、经办人映射、频道路由 </reference_index>
<skills_index>

Specialized Skills

专用技能

SkillPurposePath
overlayManage plugins in rhdh-plugin-export-overlays
../overlay/SKILL.md
create-pluginCreate, export, package, and wire RHDH dynamic plugins
../create-plugin/SKILL.md
rhdh-localEnable/disable/test plugins in local RHDH
../rhdh-local/SKILL.md
rhdh-pr-reviewPR code review and live cluster testing
../rhdh-pr-review/SKILL.md
rhdh-test-plan-reviewReviews an RHDH test plan Jira ticket and suggests platform/integration version updates
../rhdh-test-plan-review/SKILL.md
技能用途路径
overlay管理rhdh-plugin-export-overlays中的插件
../overlay/SKILL.md
create-plugin创建、导出、打包并连接RHDH动态插件
../create-plugin/SKILL.md
rhdh-local在本地RHDH中启用/禁用/测试插件
../rhdh-local/SKILL.md
rhdh-pr-reviewPR代码评审和实时集群测试
../rhdh-pr-review/SKILL.md
rhdh-test-plan-review评审RHDH测试计划Jira工单并建议平台/集成版本更新
../rhdh-test-plan-review/SKILL.md

Shared References

共享参考

ReferencePurposePath
rhdh-reposRepository map, ecosystem relationships, key paths
references/rhdh-repos.md
versionsRHDH/Backstage version compatibility matrix
references/versions.md
</skills_index>
参考用途路径
rhdh-repos仓库映射、生态系统关系、关键路径
references/rhdh-repos.md
versionsRHDH/Backstage版本兼容性矩阵
references/versions.md
</skills_index>