Skip to content

AGENTS.md: Add notes on plugin SDK, git workflow and release branches #2103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 3 commits into from
Jun 18, 2026
+19 −2
Merged

AGENTS.md: Add notes on plugin SDK, git workflow and release branches #2103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6bd7618
Add plugin SDK doc references to AGENTS.md
kyoto Jun 18, 2026
b4dd58b
Expand git workflow note in AGENTS.md
kyoto Jun 18, 2026
13816e3
Update note on release branch OCP version ranges
kyoto Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ extensions used by this plugin.
built-in plugin proxy at `/api/proxy/plugin/lightspeed-console-plugin/ols`. This
avoids CORS issues and leverages the console's authentication.

**Plugin SDK docs:** When working with console extensions, SDK APIs, or
PatternFly compatibility, fetch the relevant docs from the `openshift/console`
repo. The URLs below use the `main` branch of `openshift/console`; to target
a specific OCP version, replace `main` in the URL with the corresponding
`openshift/console` branch (e.g. `release-4.17`):
- SDK overview: `https://raw.githubusercontent.com/openshift/console/main/frontend/packages/console-dynamic-plugin-sdk/README.md`
- Extension types: `https://raw.githubusercontent.com/openshift/console/main/frontend/packages/console-dynamic-plugin-sdk/docs/console-extensions.md`
- API reference (hooks, components, K8s utilities): `https://raw.githubusercontent.com/openshift/console/main/frontend/packages/console-dynamic-plugin-sdk/docs/api.md`
Comment thread
coderabbitai[bot] marked this conversation as resolved.

### Data flow

The user types a prompt and optionally attaches context from the Kubernetes
Expand Down Expand Up @@ -140,13 +149,20 @@ structure, update the relevant spec files.

## Git and PR Workflow

### Release branches
- `main` — supports OpenShift 4.22+
- `release-4.19` — supports OpenShift 4.19 – 4.21
- `pattern-fly-5` — supports OpenShift 4.16 – 4.18

### Commit Messages
- Start with the Jira ticket reference: `OLS-XXXX description`
- Keep the first line under 72 characters
- Use imperative mood

### Pull Requests
This repo uses a **fork-based workflow**:
This repo uses a **fork-based workflow**. Never merge or commit directly
to `main`, `release-4.19`, or `pattern-fly-5` — all changes go through
PRs.

1. **Push to your fork**, not to `origin` (openshift/lightspeed-console)
2. **Create the PR** against `origin/main` using your fork's branch:
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ and enabled in the console operator config by a cluster administrator.

Requires OpenShift 4.16 or higher.

- `main` branch supports OpenShift 4.19+
- `main` branch supports OpenShift 4.22+
- `release-4.19` branch supports OpenShift 4.19 – 4.21
- `pattern-fly-5` branch supports OpenShift 4.16 – 4.18

[Node.js](https://nodejs.org/en/) >= 22 and [npm](https://www.npmjs.com) are
Expand Down