Skip to content

nit: update readme #16

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
swghosh merged 1 commit into from
Feb 16, 2026
Merged

nit: update readme #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
59 changes: 42 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ AI-driven Feature Development tools.

Add the marketplace:
```shell
/plugin marketplace add chiragkyal/oape-ai-e2e
/plugin marketplace add shiftweek/oape-ai-e2e
```

Install the plugin:
Expand Down Expand Up @@ -37,18 +37,26 @@ Cursor can discover the commands by symlinking this repo into your `~/.cursor/co

```bash
mkdir -p ~/.cursor/commands
git clone git@github.com:chiragkyal/oape-ai-e2e.git
git clone git@github.com:shiftweek/oape-ai-e2e.git
ln -s oape-ai-e2e ~/.cursor/commands/oape-ai-e2e
```

## Available Plugins

| Plugin | Description | Commands |
| ------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------- |
| **[oape](plugins/oape/)** | AI-driven OpenShift operator development tools (includes ZTWIM test generator) | `/oape:api-generate`, `/oape:api-generate-tests`, `/oape:api-implement`, `/oape:ztwim-generate-all`, `/oape:ztwim-generate-from-pr`, `/oape:ztwim-generate-execution-steps`, `/oape:ztwim-generate-e2e-from-pr` |
| **[oape](plugins/oape/)** | AI-driven OpenShift operator development tools | `/oape:init`, `/oape:api-generate`, `/oape:api-generate-tests`, `/oape:api-implement`, `/oape:e2e-generate`, `/oape:review`, `/oape:implement-review-fixes` |

## Commands

### `/oape:init` -- Clone an Operator Repository

Clones an allowed OpenShift operator repository by short name into the current directory.

```shell
/oape:init cert-manager-operator
```

### `/oape:api-generate` -- Generate API Types from Enhancement Proposal

Reads an OpenShift enhancement proposal PR, extracts the required API changes, and generates compliant Go type definitions in the correct paths of the current OpenShift operator repository.
Expand All @@ -73,31 +81,48 @@ Reads an OpenShift enhancement proposal PR, extracts the required implementation
/oape:api-implement https://github.com/openshift/enhancements/pull/1234
```

**Typical workflow:**
```shell
# Step 1: Generate API types
/oape:api-generate https://github.com/openshift/enhancements/pull/1234
### `/oape:e2e-generate` -- Generate E2E Test Artifacts

# Step 2: Generate integration tests
/oape:api-generate-tests api/v1alpha1/
Generates e2e test artifacts by discovering the repo structure and analyzing the git diff from a base branch.

# Step 3: Generate controller implementation
/oape:api-implement https://github.com/openshift/enhancements/pull/1234
```shell
/oape:e2e-generate main
```

### ZTWIM Test Generator (inside oape)
### `/oape:review` -- Code Review Against Jira Requirements

Performs a production-grade code review that verifies code changes against Jira requirements.

Generates test scenarios, step-by-step execution with `oc` commands, and e2e Go code for [openshift/zero-trust-workload-identity-manager](https://github.com/openshift/zero-trust-workload-identity-manager) PRs. See [plugins/oape/ztwim-test-generator/README.md](plugins/oape/ztwim-test-generator/README.md) for full docs.
```shell
/oape:review OCPBUGS-12345
/oape:review OCPBUGS-12345 origin/release-4.15
```

### `/oape:implement-review-fixes` -- Apply Fixes from Review Report

**Single command (all artifacts):**
Automatically applies code fixes from a review report.

```shell
/oape:ztwim-generate-all https://github.com/openshift/zero-trust-workload-identity-manager/pull/92
/oape:implement-review-fixes <report-path>
```

Writes `test-cases.md`, `execution-steps.md`, `<prno>_test_e2e.go`, and `e2e-suggestions.md` into `output/ztwim_pr_<number>/`.
**Typical workflow:**
```shell
# Step 1: Clone the operator repository
/oape:init cert-manager-operator

# Step 2: Generate API types
/oape:api-generate https://github.com/openshift/enhancements/pull/1234

# Step 3: Generate integration tests
/oape:api-generate-tests api/v1alpha1/

**Individual commands:** `/oape:ztwim-generate-from-pr`, `/oape:ztwim-generate-execution-steps`, `/oape:ztwim-generate-e2e-from-pr` (each with a PR URL).
# Step 4: Generate controller implementation
/oape:api-implement https://github.com/openshift/enhancements/pull/1234

# Step 5: Generate e2e tests for your changes
/oape:e2e-generate main
```

### Adding a New Command

Expand Down