Skip to content

docs(#4223): RHIDP-15302 migration design document - #4225

Draft
fullsend-ai-coder[bot] wants to merge 4 commits into
mainfrom
agent/4223-migration-design-doc
Draft

docs(#4223): RHIDP-15302 migration design document#4225
fullsend-ai-coder[bot] wants to merge 4 commits into
mainfrom
agent/4223-migration-design-doc

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Create the RHIDP-15302 migration design document at workspaces/boost/specifications/ai-asset-upstream-migration-design.md covering all seven AI-asset categories per Decision 1.

The document maps current RHDH entity kinds and spec.type values to their upstream Backstage targets with confidence levels, provides field-level transformation rules per category, identifies consumer-facing changes (catalog UI filters, entity refs, API queries), and defines a backward compatibility strategy (keep rhdh.io/ai-asset-category annotation for one major version).

Key decisions reflected:

  • MCP server: kind already aligned (API), no rename to McpServer
  • Model server: conditional on backstage#34476 (Resource to API)
  • Skills/rules: AiResource shipped upstream, casing alignment
  • Agent/AI model/skill-bundle: low confidence, track upstream
  • vector-store/ai-tool: explicitly out of scope
  • Sign-off section present but unsigned (human follow-up)

Cross-links added from migration-readiness/spec.md and tasks.md group 8 (8.1-8.4 marked complete). Cites #4211 (model-server downstream) and #4164 (AiResource agent schema).


Closes #4223

Post-script verification

  • Branch is not main/master (agent/4223-migration-design-doc)
  • Secret scan passed (gitleaks — 50e15634144ae07c82570c13c6fd960e03e20765..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Create the RHIDP-15302 migration design document at
workspaces/boost/specifications/ai-asset-upstream-migration-design.md
covering all seven AI-asset categories per Decision 1.

The document maps current RHDH entity kinds and spec.type values
to their upstream Backstage targets with confidence levels, provides
field-level transformation rules per category, identifies
consumer-facing changes (catalog UI filters, entity refs, API
queries), and defines a backward compatibility strategy (keep
rhdh.io/ai-asset-category annotation for one major version).

Key decisions reflected:
- MCP server: kind already aligned (API), no rename to McpServer
- Model server: conditional on backstage#34476 (Resource to API)
- Skills/rules: AiResource shipped upstream, casing alignment
- Agent/AI model/skill-bundle: low confidence, track upstream
- vector-store/ai-tool: explicitly out of scope
- Sign-off section present but unsigned (human follow-up)

Cross-links added from migration-readiness/spec.md and tasks.md
group 8 (8.1-8.4 marked complete). Cites #4211 (model-server
downstream) and #4164 (AiResource agent schema).

Closes #4223
@fullsend-ai-coder fullsend-ai-coder Bot added the ready-for-review Agent PR ready for human review label Aug 10, 2026
@codecov

codecov Bot commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.34%. Comparing base (50e1563) to head (cd1043c).
⚠️ Report is 4 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4225   +/-   ##
=======================================
  Coverage   58.34%   58.34%           
=======================================
  Files        2433     2433           
  Lines       96793    96793           
  Branches    26925    26925           
=======================================
  Hits        56470    56470           
  Misses      38853    38853           
  Partials     1470     1470           
Flag Coverage Δ *Carryforward flag
adoption-insights 84.55% <ø> (ø) Carriedforward from 4bf0a0d
ai-integrations 69.16% <ø> (ø) Carriedforward from 4bf0a0d
app-defaults 69.79% <ø> (ø) Carriedforward from 4bf0a0d
augment 46.67% <ø> (ø) Carriedforward from 4bf0a0d
boost 76.77% <ø> (ø)
bulk-import 72.79% <ø> (ø) Carriedforward from 4bf0a0d
cost-management 13.55% <ø> (ø) Carriedforward from 4bf0a0d
dcm 67.21% <ø> (ø) Carriedforward from 4bf0a0d
extensions 56.59% <ø> (ø) Carriedforward from 4bf0a0d
global-floating-action-button 71.18% <ø> (ø) Carriedforward from 4bf0a0d
global-header 66.50% <ø> (ø) Carriedforward from 4bf0a0d
homepage 47.50% <ø> (ø) Carriedforward from 4bf0a0d
install-dynamic-plugins 59.95% <ø> (ø) Carriedforward from 4bf0a0d
intelligent-assistant 75.24% <ø> (ø) Carriedforward from 4bf0a0d
konflux 91.98% <ø> (ø) Carriedforward from 4bf0a0d
lightspeed 69.02% <ø> (ø) Carriedforward from 4bf0a0d
mcp-integrations 83.40% <ø> (ø) Carriedforward from 4bf0a0d
orchestrator 66.91% <ø> (ø) Carriedforward from 4bf0a0d
quickstart 63.74% <ø> (ø) Carriedforward from 4bf0a0d
sandbox 79.56% <ø> (ø) Carriedforward from 4bf0a0d
scorecard 86.23% <ø> (ø) Carriedforward from 4bf0a0d
theme 88.77% <ø> (ø) Carriedforward from 4bf0a0d
translations 5.12% <ø> (ø) Carriedforward from 4bf0a0d
x2a 79.20% <ø> (ø) Carriedforward from 4bf0a0d

*This pull request uses carry forward flags. Click here to find out more.


Continue to review full report in Codecov by Harness.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 50e1563...cd1043c. Read the comment docs.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mareklibra

Copy link
Copy Markdown
Member

/fs-fix CI issues (prettier)

@fullsend-ai-coder

fullsend-ai-coder Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 9:59 AM UTC · Completed 10:11 AM UTC

Commit: a19b6f6 · View workflow run →

Reformat markdown tables in ai-asset-upstream-migration-design.md
to satisfy prettier CI checks.

Addresses review feedback on #4225
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 1 (human-triggered)

Fixed prettier CI failure by reformatting markdown tables in ai-asset-upstream-migration-design.md. Changes are purely cosmetic (table column alignment and trailing whitespace removal).

Fixed (1):

  1. prettier formatting failures in CI (workspaces/boost/specifications/ai-asset-upstream-migration-design.md): Ran prettier --write to reformat markdown tables (column alignment, trailing whitespace). All tables now pass prettier:check.

Tests: passed

Updated by fullsend fix agent

@mareklibra

Copy link
Copy Markdown
Member

/fs-review

@fullsend-ai-review

fullsend-ai-review Bot commented Aug 10, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 10:19 AM UTC · Completed 10:32 AM UTC

Commit: 5c81e97 · View workflow run →

@fullsend-ai-review

fullsend-ai-review Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review

Findings

Low

  • [internal-consistency] workspaces/boost/specifications/ai-asset-upstream-migration-design.md — The document has two "Out of Scope" sections with overlapping content: a subsection ### Out of scope under Purpose/Scope (lines 74–87) listing five items, and a standalone ## Out of Scope section (lines 333–349) listing six items. Both cover vector-store/ai-tool, dry-run CLI, and annotation spec; the standalone section adds live catalog migration, catalog processor, and entity kind transition plan. Consider consolidating into a single section to avoid drift between the two lists.

  • [blockquote-formatting-convention] workspaces/boost/openspec/changes/ai-catalog-entity-model/tasks.md:87 — The new blockquote in section 8 does not follow the established bold-label-with-colon pattern used elsewhere in this file (e.g., > **RHDHPLAN-1507 Consolidation (2026-07-08):** ..., > **Cross-connector dependencies:** ...). Consider reformatting to > **Implementation:** Tasks 8.1-8.4 implemented in ....

  • [cross-reference-consistency] workspaces/boost/specifications/ai-asset-upstream-migration-design.md:139 — The confidence level label "Medium-High" uses a regular ASCII hyphen, while the authoritative definitions in upstream-schema-alignment/design.md, proposal.md, and migration-readiness/spec.md consistently use an en-dash ("Medium–High"). Consider aligning to the en-dash convention to match existing documentation.

Previous run

Review

Findings

High

  • [broken cross-reference] workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/spec.md:4 — The relative link ../../../../specifications/ai-asset-upstream-migration-design.md resolves incorrectly. From spec.md's directory (workspaces/boost/openspec/changes/ai-catalog-entity-model/specs/migration-readiness/), four ../ levels reach workspaces/boost/openspec/, producing the non-existent path workspaces/boost/openspec/specifications/ai-asset-upstream-migration-design.md. The link needs five ../ levels to reach workspaces/boost/ before descending into specifications/.
    Remediation: Change to ../../../../../specifications/ai-asset-upstream-migration-design.md.

  • [broken cross-reference] workspaces/boost/openspec/changes/ai-catalog-entity-model/tasks.md:87 — The relative link ../../specifications/ai-asset-upstream-migration-design.md resolves incorrectly. From tasks.md's directory (workspaces/boost/openspec/changes/ai-catalog-entity-model/), two ../ levels reach workspaces/boost/openspec/, producing the non-existent path workspaces/boost/openspec/specifications/ai-asset-upstream-migration-design.md. The link needs three ../ levels to reach workspaces/boost/.
    Remediation: Change to ../../../specifications/ai-asset-upstream-migration-design.md.

Low

  • [heading format] workspaces/boost/specifications/ai-asset-upstream-migration-design.md:15 — Top-level H2 headings use numbered format (e.g., ## 1. Purpose, ## 2. Current-State Source of Truth) whereas sibling files in specifications/ use unnumbered descriptive H2 headings. Consider removing number prefixes to match sibling documents.

Labels: PR modifies documentation files exclusively under workspaces/boost/


Next steps:

  • /fs-fix — agent addresses review findings automatically
  • /fs-fix <your instruction> — agent fixes with your specific guidance
  • Push commits directly — review re-runs automatically on push
  • /fs-fix-stop — disable automatic fix runs for this PR

fullsend-ai-review[bot]

This comment was marked as outdated.

@fullsend-ai-review fullsend-ai-review Bot added workspace/boost Boost workspace (Backstage AI plugin) documentation Improvements or additions to documentation labels Aug 10, 2026
Correct broken cross-links to the design doc, complete model-server
field mapping for backstage#34476, and clarify MCP remotes, AiResource
citations, and heading style.

Signed-off-by: Marek Libra <marek.libra@gmail.com>
@mareklibra

Copy link
Copy Markdown
Member

Added manually crafted commit.

@mareklibra

Copy link
Copy Markdown
Member

/fs-review

@fullsend-ai-review

fullsend-ai-review Bot commented Aug 10, 2026

Copy link
Copy Markdown

🤖 Review · ❌ Terminated · Started 11:36 AM UTC · Ended 11:54 AM UTC

Commit: 4bf0a0d · View workflow run →

Use catalog annotation filter paths, spell out Skill/Rule and
spec.models transformations, and dedupe Out of scope.
@fullsend-ai-review
fullsend-ai-review Bot dismissed their stale review August 10, 2026 11:54

Superseded by updated review

- [ ] 8.2 Document transformation rules for each AI asset category (RHIDP-15302)
- [ ] 8.3 Identify consumer-facing changes: catalog UI filters, entity refs, API queries (RHIDP-15302)
- [ ] 8.4 Document backward compatibility strategy (e.g., keep annotation for one major version) (RHIDP-15302)
> Tasks 8.1-8.4 implemented in [ai-asset-upstream-migration-design.md](../../../specifications/ai-asset-upstream-migration-design.md) via [#4223](https://github.com/redhat-developer/rhdh-plugins/issues/4223).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] blockquote-formatting-convention

The new blockquote does not follow the established bold-label-with-colon pattern used elsewhere in tasks.md (e.g., '> Label: description').

| --------------------- | ----------------- | -------------------------------- | ------------------------------------------------------------- |
| `kind` | `Resource` | `API` | Kind change from Resource to API. |
| `spec.type` | `ai-model-server` | `ai-model-server` | No change to type value. |
| `spec.owner` | Standard | Standard | No change (both kinds use `spec.owner`). |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[low] cross-reference-consistency

The confidence level label 'Medium-High' uses a regular ASCII hyphen while authoritative definitions in other specification files use an en-dash ('Medium-High' vs 'Medium–High').

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Aug 10, 2026
@fullsend-ai-review

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 11:36 AM UTC · Completed 11:54 AM UTC

Commit: 4bf0a0d · View workflow run →

@sonarqubecloud

Copy link
Copy Markdown

@mareklibra
mareklibra marked this pull request as draft August 10, 2026 13:46
@mareklibra

Copy link
Copy Markdown
Member

Converting to draft, still thinking about the approach

mareklibra added a commit that referenced this pull request Aug 10, 2026
Make OpenSpec migration-plan.md the explicit RHIDP-15302 design SoT
via cross-links from spec.md and tasks.md, and add a thin
specifications/ pointer for platform-engineer discoverability without
duplicating mapping tables. Supersedes the parallel #4223/#4225 track.
Part of #4042
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress documentation Improvements or additions to documentation ready-for-merge All reviewers approved — ready to merge ready-for-review Agent PR ready for human review workspace/boost Boost workspace (Backstage AI plugin)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(boost): RHIDP-15302 migration design document (from #4042)

1 participant