plugin-api-review

Review OpenShift Console plugin API changes for compliance with contribution guidelines.

459|737|Updated Apr 13, 2018
One-click install
npx skills add https://github.com/openshift/console --skill plugin-api-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plugin-api-review
Source: https://github.com/openshift/console/tree/main/.claude/skills/plugin-api-review
Command: npx skills add https://github.com/openshift/console --skill plugin-api-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps teams validate OpenShift Console plugin API changes against contribution guidelines, styleguide, and changelog documentation to ensure proper governance and traceability.

Core Features & Use Cases

  • Detailed compliance review of plugin API changes including deprecations, breaking changes, and required changelog updates.
  • Generated findings and compliance score to guide remediation, with recommendations for developers and teams.
  • Use cases include PR reviews, staging gate checks, and release readiness for dynamic-plugin-sdk extensions.

Quick Start

Run the plugin-api-review tool to generate a compliance report for your plugin API changes.

Frequently Asked Questions about plugin-api-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check OpenShift Console plugin API changes for backward compatibility?

To check OpenShift Console plugin API changes for backward compatibility, you can review API deprecations and breaking changes against contribution guidelines to ensure proper governance and traceability.

What is the best way to validate dynamic plugin SDK extension points before merging?

Validating dynamic plugin SDK extension points involves reviewing documented changes to shared modules and extension points, generating a detailed compliance report with findings and a compliance score to guide remediation.

Does the plugin API review process enforce changelog documentation for staging PRs?

Yes, the plugin API review process enforces changelog documentation for staging PRs by checking that required changelog updates are present for in-development plugin changes and commits not yet on main.

How do I generate a compliance report for OpenShift Console plugin API changes?

You generate a compliance report for OpenShift Console plugin API changes by running the review tool against your commits, which evaluates adherence to the styleguide and contribution guidelines.

Can I use this API review for release readiness checks of dynamic-plugin-sdk extensions?

Yes, you can use this API review for release readiness checks of dynamic-plugin-sdk extensions, as it produces a compliance score and detailed findings to ensure all changes meet governance standards.

What limitations exist when reviewing in-development plugin API changes?

A limitation when reviewing in-development plugin API changes is that the review relies on the provided commits and staging PRs, meaning uncommitted local code outside the dynamic plugin SDK guidelines is not evaluated.