Skip to content

[NO-JIRA]: Add plugins doc section on Console version compatibility#16133

Open
vojtechszocs wants to merge 1 commit intoopenshift:mainfrom
vojtechszocs:doc-updates
Open

[NO-JIRA]: Add plugins doc section on Console version compatibility#16133
vojtechszocs wants to merge 1 commit intoopenshift:mainfrom
vojtechszocs:doc-updates

Conversation

@vojtechszocs
Copy link
Contributor

@vojtechszocs vojtechszocs commented Mar 11, 2026

Summary by CodeRabbit

  • Documentation
    • Added Console version compatibility guidance for dynamic plugins, covering strategies for managing single and multiple Console versions per code branch with pros, cons, and implementation examples.

@openshift-ci openshift-ci bot requested review from jhadvig and rhamilto March 11, 2026 20:02
@openshift-ci openshift-ci bot added the component/sdk Related to console-plugin-sdk label Mar 11, 2026
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 11, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vojtechszocs

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 Mar 11, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 11, 2026

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: 8efe80a2-fc35-4c8f-a48e-65b57a7633d0

📥 Commits

Reviewing files that changed from the base of the PR and between 21101de and 3d8213c.

📒 Files selected for processing (1)
  • frontend/packages/console-dynamic-plugin-sdk/README.md

📝 Walkthrough

Walkthrough

This change adds documentation to the Console dynamic plugin SDK README outlining version compatibility strategies for plugin developers. It introduces guidance for two approaches: maintaining separate code branches targeting specific Console versions, or supporting multiple Console versions within a single branch. The documentation includes examples, trade-offs, and recommendations for plugin SDK versioning and CI configurations. The content is duplicated across two locations within the README. No code modifications or behavioral changes are included.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding documentation about Console version compatibility strategies for dynamic plugins.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@vojtechszocs
Copy link
Contributor Author

@jseseCCS Hi, can you please review this docs change?

@logonoff
Copy link
Member

/label px-approved

@openshift-ci openshift-ci bot added the px-approved Signifies that Product Support has signed off on this PR label Mar 11, 2026
@vojtechszocs
Copy link
Contributor Author

/retest

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 12, 2026

@vojtechszocs: all tests passed!

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.

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/sdk Related to console-plugin-sdk px-approved Signifies that Product Support has signed off on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants