Skip to content

feat: breaking change skill - #116

Merged
jpuzz0 merged 2 commits into
patternfly:mainfrom
dlabaj:breaking
Jul 7, 2026
Merged

feat: breaking change skill#116
jpuzz0 merged 2 commits into
patternfly:mainfrom
dlabaj:breaking

Conversation

@dlabaj

@dlabaj dlabaj commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Created skill that checks for breaking changes by react.

Summary by CodeRabbit

  • New Features

    • Added a new migration skill: PF React Breaking Changes, which scans @patternfly/react-* for API-breaking changes and generates a markdown report.
  • Documentation

    • Updated the plugins and migration documentation to include the new skill and workflow.
    • Added a detailed skill guide describing scan scope, workflow, and output expectations.
    • Added a standardized report template covering severity, affected components/packages, and recommended migration steps.

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: af8de0c1-2a01-4f3e-bbf4-d104322a1078

📥 Commits

Reviewing files that changed from the base of the PR and between cd0c269 and df5f992.

📒 Files selected for processing (4)
  • PLUGINS.md
  • plugins/migration/README.md
  • plugins/migration/skills/pf-react-breaking-changes/SKILL.md
  • plugins/migration/skills/pf-react-breaking-changes/references/report-template.md
✅ Files skipped from review due to trivial changes (2)
  • PLUGINS.md
  • plugins/migration/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • plugins/migration/skills/pf-react-breaking-changes/references/report-template.md

📝 Walkthrough

Walkthrough

A new pf-react-breaking-changes migration skill is added with a guide, a markdown report template, and documentation updates in README.md and PLUGINS.md.

Changes

pf-react-breaking-changes skill addition

Layer / File(s) Summary
Skill guide and report template
plugins/migration/skills/pf-react-breaking-changes/SKILL.md, plugins/migration/skills/pf-react-breaking-changes/references/report-template.md
SKILL.md defines the skill metadata, scope, workflow, detection patterns, report defaults, and checklist. The report template adds the markdown structure for findings, migration steps, exclusions, and references.
Skill registration in docs
plugins/migration/README.md, PLUGINS.md
The migration README and top-level plugin list add the new skill entry and update the documented file structure.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • patternfly/ai-helpers#95: Earlier migration-plugin work that introduced the migration skill area and related documentation structure.

Suggested reviewers: jpuzz0

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is concise and clearly points to the new breaking-change skill introduced by this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Linked repositories: Public OSS repositories can only analyze public repositories installed in this organization. No linked repositories were analyzed; skipped anthropics/claude-plugins-official.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@plugins/migration/skills/pf-react-breaking-changes/SKILL.md`:
- Around line 1-7: The SKILL.md file frontmatter is missing the required
`disable-model-invocation: true` field. Since this skill writes a markdown
report file to the project root (pf-react-breaking-changes-report.md), it has
filesystem side effects and must declare this flag to prevent AI models from
invoking it programmatically. Add the `disable-model-invocation: true` field to
the YAML frontmatter in the skill definition.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1d3a40c1-169c-4b76-b68d-25f5323b3a0a

📥 Commits

Reviewing files that changed from the base of the PR and between bd8becd and adbdf6c.

📒 Files selected for processing (4)
  • PLUGINS.md
  • plugins/migration/README.md
  • plugins/migration/skills/pf-react-breaking-changes/SKILL.md
  • plugins/migration/skills/pf-react-breaking-changes/references/report-template.md

Comment thread plugins/migration/skills/pf-react-breaking-changes/SKILL.md

### 3. Load authoritative breaking changes

Use the **PatternFly MCP server** before guessing:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What happens if the user doesn't have the PatternFly MCP installed? Would a brief fallback sentence here (e.g., "If MCP is unavailable, reference the pf-codemods README and upgrade guide directly") prevent the AI from stalling when it can't find searchPatternFlyDocs?


When MCP/docs identify a breaking change, search the codebase with targeted patterns:

```bash

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nit: these rg examples use PF5→PF6 component names (Chip, KebabToggle, Tile). Since the skill also targets minor/patch upgrades (line 87), would a brief note above clarifying these are PF5→PF6 illustrations help prevent the AI from searching for Chip during a 6.2→6.3 upgrade?

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
plugins/migration/skills/pf-react-breaking-changes/SKILL.md (1)

94-99: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Pin the codemods example.

@latest makes this dry-run pull a moving npm target each time, so the skill can drift as upstream releases change. Please verify whether that is intentional; otherwise pin a released @patternfly/pf-codemods version here. Based on the static-analysis hint about unpinned npx invocations.

Fix
- npx `@patternfly/pf-codemods`@latest --v6 <scan-path>
+ npx `@patternfly/pf-codemods`@<pinned-version> --v6 <scan-path>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@plugins/migration/skills/pf-react-breaking-changes/SKILL.md` around lines 94
- 99, The dry-run codemods example in SKILL.md is using a moving npm target via
the PF codemods command, which should be pinned if that drift is not
intentional. Update the example under the PF6 upgrade guidance to reference a
specific released `@patternfly/pf-codemods` version instead of the current
floating target, keeping the rest of the command structure unchanged. Please
verify the example remains accurate for the documented machine-verification
flow.

Source: Linters/SAST tools

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@plugins/migration/skills/pf-react-breaking-changes/SKILL.md`:
- Around line 94-99: The dry-run codemods example in SKILL.md is using a moving
npm target via the PF codemods command, which should be pinned if that drift is
not intentional. Update the example under the PF6 upgrade guidance to reference
a specific released `@patternfly/pf-codemods` version instead of the current
floating target, keeping the rest of the command structure unchanged. Please
verify the example remains accurate for the documented machine-verification
flow.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: da9ce4ee-91ef-4fad-897b-ec8dfcca68ae

📥 Commits

Reviewing files that changed from the base of the PR and between adbdf6c and cd0c269.

📒 Files selected for processing (1)
  • plugins/migration/skills/pf-react-breaking-changes/SKILL.md

@jpuzz0 jpuzz0 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM, but you need to resolve the merge conflict with main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants