rhdh-upgrade-helper

<quick_start> Invoke with:

• Config file: /rhdh-upgrade-helper (reads .rhdh-upgrade-helper.yaml from cwd)
• Individual files: /rhdh-upgrade-helper --to 1.10 --config ./values.yaml --config ./app-config.yaml
• Directory: /rhdh-upgrade-helper --to 1.10 --config-path ./my-configs/
• Interactive: /rhdh-upgrade-helper --to 1.10
• Skip-release: /rhdh-upgrade-helper --from 1.8 --to 1.10 --config ./values.yaml
• Chart migration: /rhdh-upgrade-helper --from 1.10 --to 2.1 --config ./values.yaml

Arguments: [--to X.Y] [--from X.Y] [--config /path/to/file] [--config-path /dir]

• --to X.Y (required): Target RHDH release version to upgrade TO.
• --from X.Y (optional): Source RHDH release version upgrading FROM. Defaults to the release immediately before --to. Use when skipping releases (e.g., --from 1.8 --to 1.10).
• --config /path/to/file (optional, repeatable): Path to an individual config file. Can be specified multiple times. Accepts values.yaml, app-config.yaml, dynamic-plugins.yaml, Backstage CR, or any YAML with RHDH configuration. File type is auto-detected from content.
• --config-path /dir (optional): Path to a directory to scan for config files. When provided, scans for known file patterns. Can be combined with --config for additional files.
• When no config source is given, the skill checks for .rhdh-upgrade-helper.yaml in the current directory. If not found, it asks intake questions to build your environment profile. See references/rhdh-upgrade-helper-config.md. </quick_start>

1. Your environment — either parsed from config files (--config-path) or built from intake questions. Determines which plugins, auth providers, and features you use.
2. Product context — release diffs, breaking changes, plugin version jumps, support level changes, bundle-to-OCI migrations. Gathered first from the shipped plugin-catalog-index image, which includes productized plugin metadata and documentation, with the public rhdh-plugin-export-overlays repo as a fallback, plus RHDH release notes. Determines what changed between your current and target releases.
3. Known bug data — For each plugin in your config, the skill searches the RHDHBUGS Jira project for open bugs affecting that plugin in the target release. Also queries GitHub Issues on redhat-developer/rhdh for community-reported upgrade issues. If Jira is not accessible, falls back to GitHub Issues and release notes only.
4. Chart migration data — For major version upgrades (1.y → 2.y), the chart values migration reference (references/chart-migration-1y-2y.md) provides deterministic key mappings and ambiguous area guidance. The migration script (scripts/migrate-chart-values.py) automates mechanical translations and flags areas needing AI-assisted resolution.

The skill correlates these to answer: "Of all the changes in the target release, which ones actually affect MY setup?"

Config file

When a .rhdh-upgrade-helper.yaml file exists in the current directory (or in --config-path), the skill reads file paths and release versions from it. This avoids re-typing flags on repeat runs. See references/rhdh-upgrade-helper-config.md.

Config analysis

When config files are provided (via .rhdh-upgrade-helper.yaml, --config, or --config-path), parsing follows references/config-analysis.md. File type is auto-detected from content — supports Helm values, app-config, dynamic-plugins config, Backstage CR, and .env files.

Security

All config files are scanned for embedded secrets before processing. See references/secrets-detection.md. Template variable references (${VAR}) are safe — only literal secret values are flagged. </context>

--to is always required. If omitted, prompt for it before routing. .rhdh-upgrade-helper.yaml may provide it. Major version detection: If the major version differs between --from and --to (e.g., 1.10 → 2.1) and a Helm values file is provided, route to workflows/chart-migration.md first. This handles chart values restructuring, then optionally runs workflows/full-report.md for the full upgrade assessment. When no config files are resolved, always route to workflows/interactive.md — never produce a generic report without gathering environment context first. </routing>

<reference_index>

<workflows_index>

<anti_patterns> <pitfall name="generic-advice-without-context"> Never produce migration advice without knowing the customer's environment. If no --config-path is given, ask intake questions first. "Update your auth config" is useless without knowing which auth provider they use. </pitfall>

<success_criteria> The report is complete when:

• All config files scanned for secrets per references/secrets-detection.md before any analysis
• Target release resolved to Backstage version via the shipped catalog-index image or explicitly labeled overlay fallback
• Customer's environment determined (from config or intake questions)
• Product context gathered for the release range
• Per-plugin bug search run against RHDHBUGS Jira (if accessible) and redhat-developer/rhdh GitHub Issues
• Every breaking change classified as "affects you" or "does NOT affect you" based on environment overlap
• Readiness score computed with transparent breakdown per references/config-scoring.md
• Migration actions are specific: file path, line number (when from config), current value, replacement, reason
• "Does NOT Affect You" section included to reduce upgrade anxiety
• RHDH Local recommended for pre-upgrade testing per references/rhdh-local.md
• Upgrade checklist provided at end of report
• For major version upgrades: chart values migration completed via workflows/chart-migration.md, all ambiguous areas resolved with user confirmation, migrated values file validated with helm template </success_criteria>