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

[kyoto]

Summary by CodeRabbit

• Documentation
  • Expanded contributor workflow guidance, including new Plugin SDK development resources (with direct references) and clearer release-branch information.
  • Updated OpenShift version support policy: the main branch now targets OpenShift 4.22+, while the release-4.19 branch supports OpenShift 4.19–4.21.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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:

• OWNERS

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

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by:

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:

• OWNERS

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

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ddee0e4e-29bd-4cd5-a4c0-4a3c0d6839b9

📥 Commits

Reviewing files that changed from the base of the PR and between 0015fc1 and 13816e3.

📒 Files selected for processing (2)

• AGENTS.md
• README.md

✅ Files skipped from review due to trivial changes (2)

• README.md
• AGENTS.md

---

📝 Walkthrough

Walkthrough

README.md updates the OpenShift version compatibility note to split main (4.22+) from release-4.19 (4.19–4.21). AGENTS.md adds a "Plugin SDK docs" subsection with three SDK resource URLs, includes a "Release branches" list showing version support by branch, and rewrites the Pull Requests section to make the fork-based workflow requirement explicit.

Changes

Documentation updates

Layer / File(s)	Summary
SDK docs, version compatibility, and release guidance README.md, AGENTS.md	README.md splits the single OpenShift version note into per-branch ranges (main: 4.22+, release-4.19: 4.19–4.21). AGENTS.md adds a "Plugin SDK docs" subsection under Architecture with three SDK resource URLs, adds a "Release branches" list to the Git workflow section, and rewrites the Pull Requests entry to explicitly state the fork-based workflow requirement.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hippity-hop through the docs I go,
Adding SDK links in a tidy row,
Release branches now clearly in sight,
Fork your PR and you'll be all right!
The README splits versions with a flourish — how bright! ✨

🚥 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 accurately reflects the main changes in the PR: adding documentation about plugin SDK, git workflow guidance, and release branches to AGENTS.md.
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.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

AGENTS.md (1)

161-180: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Parameterize the PR base branch.

Now that the workflow docs list main, release-4.19, and pattern-fly-5, this example should not hardcode main; otherwise release-line work will be opened against the wrong base.

Based on learnings: Never merge or commit directly to main, release-4.19, or pattern-fly-5 — all changes must go through pull requests using a fork-based workflow.

Suggested edit

-2. **Create the PR** against `origin/main` using your fork's branch:
+2. **Create the PR** against the branch you're updating using your fork's branch:
@@
-   gh pr create --repo openshift/lightspeed-console --head <your-github-user>:<branch> --base main
+   gh pr create --repo openshift/lightspeed-console --head <your-github-user>:<branch> --base <target-branch>
@@
-4. **Create the PR** against `origin/main` using `--head <user>:<branch>`
+4. **Create the PR** against the target branch using `--head <user>:<branch>`

🤖 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 `@AGENTS.md` around lines 161 - 180, The Pull Requests section hardcodes `main`
as the base branch in the gh pr create command and in the Branch Completion
section, but the workflow documentation states that changes should go against
different protected branches (main, release-4.19, or pattern-fly-5) depending on
the work. Replace the hardcoded `main` in both the gh pr create command (in the
`--base` flag) and in the "Create the PR against `origin/main`" instruction in
the Branch Completion section with a parameterized placeholder like
`<base-branch>` so that developers can specify the correct target branch for
their work, whether it's main, release-4.19, or pattern-fly-5. This ensures the
documentation guidance aligns with the multi-branch workflow.

Source: Learnings

🤖 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 `@AGENTS.md`:
- Around line 30-36: Update the Plugin SDK docs section to use an actually
supported branch name instead of the stale example. Replace the reference to
`release-4.17` in the parenthetical instruction about swapping branch names with
either a generic placeholder or use one of the repo's documented supported
branches like `release-4.19`. This ensures the documentation example accurately
reflects available branches in the openshift/console repository.

---

Outside diff comments:
In `@AGENTS.md`:
- Around line 161-180: The Pull Requests section hardcodes `main` as the base
branch in the gh pr create command and in the Branch Completion section, but the
workflow documentation states that changes should go against different protected
branches (main, release-4.19, or pattern-fly-5) depending on the work. Replace
the hardcoded `main` in both the gh pr create command (in the `--base` flag) and
in the "Create the PR against `origin/main`" instruction in the Branch
Completion section with a parameterized placeholder like `<base-branch>` so that
developers can specify the correct target branch for their work, whether it's
main, release-4.19, or pattern-fly-5. This ensures the documentation guidance
aligns with the multi-branch workflow.

🪄 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: Enterprise

Run ID: 9985b00f-4d4a-4739-8ea0-8516d6de2cb2

📥 Commits

Reviewing files that changed from the base of the PR and between 0209eac and 0015fc1.

📒 Files selected for processing (2)

• AGENTS.md
• README.md

[openshift-ci]

New changes are detected. LGTM label has been removed.

[kyoto]

/override "Red Hat Konflux / e2e-console-pf6 / lightspeed-console"

[kyoto]

/cherry-pick release-4.19
/cherry-pick pattern-fly-5

[openshift-cherrypick-robot]

@kyoto: once the present PR merges, I will cherry-pick it on top of pattern-fly-5, release-4.19 in new PRs and assign them to you.

Details

In response to this:

/cherry-pick release-4.19
/cherry-pick pattern-fly-5

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.

[openshift-ci]

@kyoto: Overrode contexts on behalf of kyoto: Red Hat Konflux / e2e-console-pf6 / lightspeed-console

Details

In response to this:

/override "Red Hat Konflux / e2e-console-pf6 / lightspeed-console"

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.