Skip to content

Conversation

@logonoff
Copy link
Member

@logonoff logonoff commented Oct 29, 2025

example output from #15655

Plugin API Review Report

API change: Internal refactoring to always use canonical model references
JIRA issue: CONSOLE-4837
Current OpenShift version: 4.21
Changes to changelog made? N/A - No plugin API changes

Summary

The changes in this branch are internal console refactoring and do not affect the plugin API. The modified files are:

These files are not part of the @openshift-console/dynamic-plugin-sdk package and are not exported as shared modules or extension APIs. They are internal console implementation files in the frontend/public directory.

Findings

  •  Reviewed changes for plugin API impact - No plugin API changes detected
  •  Verified that the change does not need to be documented in the "Changes to plugin API" section of the dynamic plugin SDK release notes - not applicable
  •  Verified that the change does not need to be documented in the "Changes to shared modules and API" section of the dynamic plugin SDK release notes - not applicable
  •  Verified that the change does not need to be documented in the SDK core changelog - not applicable
  •  Verified that the change does not need to be documented in the SDK webpack changelog - not applicable
  •  Verified that no CSS class changes require documentation - no CSS files modified
  •  Verified that a JIRA issue is associated with the change - CONSOLE-4837
  •  Verified that the styleguide is followed for all changed files

Issues found during review

Code Quality Observations (not plugin API compliance issues):

  1. In frontend/public/kinds.ts, the usePlural function calls buildK8sKind() with the result of modelMetadata.find() which can return undefined. This may cause runtime errors if no matching metadata is found.
  2. Potential null reference in buildK8sKind where metadata.properties?.labelPlural.toLowerCase() doesn't use optional chaining on the .toLowerCase() call.

These are internal implementation issues and do not affect plugin API compliance.

Actions taken

None required - no plugin API changes to document.

Compliance score: 10/10

Reason for score:

  • All plugin API review criteria are satisfied
  • No plugin API changes were made, so no changelog documentation is required
  • JIRA issue (CONSOLE-4837) is properly associated with the changes
  • The styleguide is followed for all changed files
  • Changes are purely internal refactoring that do not affect dynamic plugins

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Oct 29, 2025
@openshift-ci-robot
Copy link
Contributor

openshift-ci-robot commented Oct 29, 2025

@logonoff: This pull request explicitly references no jira issue.

Details

In response to this:

example output from #15655

Plugin API Review Report

API change: Internal refactoring to always use canonical model references
JIRA issue: CONSOLE-4837
Current OpenShift version: 4.21
Changes to changelog made? N/A - No plugin API changes

Summary

The changes in this branch are internal console refactoring and do not affect the plugin API. The modified files are:

These files are not part of the @openshift-console/dynamic-plugin-sdk package and are not exported as shared modules or extension APIs. They are internal console implementation files in the frontend/public directory.

Findings

  •  Reviewed changes for plugin API impact - No plugin API changes detected
  •  Verified that the change does not need to be documented in the "Changes to plugin API" section of the dynamic plugin SDK release notes - not applicable
  •  Verified that the change does not need to be documented in the "Changes to shared modules and API" section of the dynamic plugin SDK release notes - not applicable
  •  Verified that the change does not need to be documented in the SDK core changelog - not applicable
  •  Verified that the change does not need to be documented in the SDK webpack changelog - not applicable
  •  Verified that no CSS class changes require documentation - no CSS files modified
  •  Verified that a JIRA issue is associated with the change - CONSOLE-4837
  •  Verified that the styleguide is followed for all changed files

Issues found during review

Code Quality Observations (not plugin API compliance issues):

  1. In frontend/public/kinds.ts, the usePlural function calls buildK8sKind() with the result of modelMetadata.find() which can return undefined. This may cause runtime errors if no matching metadata is found.
  2. Potential null reference in buildK8sKind where metadata.properties?.labelPlural.toLowerCase() doesn't use optional chaining on the .toLowerCase() call.

These are internal implementation issues and do not affect plugin API compliance.

Actions taken

None required - no plugin API changes to document.

Compliance score: 10/10

Reason for score:

  • All plugin API review criteria are satisfied
  • No plugin API changes were made, so no changelog documentation is required
  • JIRA issue (CONSOLE-4837) is properly associated with the changes
  • The styleguide is followed for all changed files
  • Changes are purely internal refactoring that do not affect dynamic plugins

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the component/core Related to console core functionality label Oct 29, 2025
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 29, 2025

@logonoff: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/backend 9452683 link true /test backend

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@logonoff
Copy link
Member Author

/verified bypass
/label px-approved
/label docs-approved

@openshift-ci openshift-ci bot added px-approved Signifies that Product Support has signed off on this PR docs-approved Signifies that Docs has signed off on this PR labels Oct 30, 2025
@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Oct 30, 2025
@openshift-ci-robot
Copy link
Contributor

@logonoff: The verified label has been added.

Details

In response to this:

/verified bypass
/label px-approved
/label docs-approved

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@Leo6Leo
Copy link
Contributor

Leo6Leo commented Oct 31, 2025

/meow

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 31, 2025

@Leo6Leo: cat image

Details

In response to this:

/meow

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Member

@spadgett spadgett left a comment

Choose a reason for hiding this comment

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

Nice, thanks! 👍

/lgtm

Comment on lines +22 to +26
- CSS classes may be inadvertently used by plugins, so changes to CSS files
should be reviewed for potential breakages. Perform a search on GitHub for
the class name to see if it is used in any public plugins. Repos which are
console dynamic plugins will always consume
`@openshift-console/dynamic-plugin-sdk` in the `package.json` file of the repo.
Copy link
Member

Choose a reason for hiding this comment

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

Nice. I assume this will not have false positives on public forks of the openshift/console repo?

Copy link
Member Author

Choose a reason for hiding this comment

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

I haven't had any problems with that yet

Comment on lines +48 to +53
- New API or extension points MUST be well documented with descriptions that are
clear enough to allow plugin authors to understand their purpose and usage without
referring back to the source code. Assume that plugin authors do not have
knowledge of the internal workings of OpenShift Console. New documentation SHOULD
contain examples of usage where applicable, edge cases and behavior when parameters
such as `null`, `undefined`, or invalid values are provided.
Copy link
Member

Choose a reason for hiding this comment

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

This is important, thank you

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 14, 2025
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Nov 14, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: logonoff, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 14, 2025
@logonoff
Copy link
Member Author

/verified by @logonoff

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Nov 14, 2025
@openshift-ci-robot
Copy link
Contributor

@logonoff: This PR has been marked as verified by @logonoff.

Details

In response to this:

/verified by @logonoff

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@logonoff
Copy link
Member Author

/hold to avoid retesting #15679

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 14, 2025
@logonoff
Copy link
Member Author

/unhold

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 14, 2025
@openshift-merge-bot openshift-merge-bot bot merged commit 040fe4e into openshift:main Nov 14, 2025
3 checks passed
@logonoff logonoff deleted the money branch November 14, 2025 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. component/core Related to console core functionality docs-approved Signifies that Docs has signed off on this PR hacktoberfest-accepted jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants