Skip to content

Commit a07c452

Browse files
swghoshclaude
andcommitted
nit: update readme
Co-authored-by: Claude <noreply@anthropic.com> Signed-off-by: Swarup Ghosh <swghosh@redhat.com>
1 parent 5de13f5 commit a07c452

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

README.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ AI-driven Feature Development tools.
66

77
Add the marketplace:
88
```shell
9-
/plugin marketplace add chiragkyal/oape-ai-e2e
9+
/plugin marketplace add shiftweek/oape-ai-e2e
1010
```
1111

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

3838
```bash
3939
mkdir -p ~/.cursor/commands
40-
git clone git@github.com:chiragkyal/oape-ai-e2e.git
40+
git clone git@github.com:shiftweek/oape-ai-e2e.git
4141
ln -s oape-ai-e2e ~/.cursor/commands/oape-ai-e2e
4242
```
4343

4444
## Available Plugins
4545

4646
| Plugin | Description | Commands |
4747
| ------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------- |
48-
| **[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` |
48+
| **[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` |
4949

5050
## Commands
5151

52+
### `/oape:init` -- Clone an Operator Repository
53+
54+
Clones an allowed OpenShift operator repository by short name into the current directory.
55+
56+
```shell
57+
/oape:init cert-manager-operator
58+
```
59+
5260
### `/oape:api-generate` -- Generate API Types from Enhancement Proposal
5361

5462
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.
@@ -73,31 +81,48 @@ Reads an OpenShift enhancement proposal PR, extracts the required implementation
7381
/oape:api-implement https://github.com/openshift/enhancements/pull/1234
7482
```
7583

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

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

84-
# Step 3: Generate controller implementation
85-
/oape:api-implement https://github.com/openshift/enhancements/pull/1234
88+
```shell
89+
/oape:e2e-generate main
8690
```
8791

88-
### ZTWIM Test Generator (inside oape)
92+
### `/oape:review` -- Code Review Against Jira Requirements
93+
94+
Performs a production-grade code review that verifies code changes against Jira requirements.
8995

90-
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.
96+
```shell
97+
/oape:review OCPBUGS-12345
98+
/oape:review OCPBUGS-12345 origin/release-4.15
99+
```
100+
101+
### `/oape:implement-review-fixes` -- Apply Fixes from Review Report
91102

92-
**Single command (all artifacts):**
103+
Automatically applies code fixes from a review report.
93104

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

98-
Writes `test-cases.md`, `execution-steps.md`, `<prno>_test_e2e.go`, and `e2e-suggestions.md` into `output/ztwim_pr_<number>/`.
109+
**Typical workflow:**
110+
```shell
111+
# Step 1: Clone the operator repository
112+
/oape:init cert-manager-operator
113+
114+
# Step 2: Generate API types
115+
/oape:api-generate https://github.com/openshift/enhancements/pull/1234
116+
117+
# Step 3: Generate integration tests
118+
/oape:api-generate-tests api/v1alpha1/
99119

100-
**Individual commands:** `/oape:ztwim-generate-from-pr`, `/oape:ztwim-generate-execution-steps`, `/oape:ztwim-generate-e2e-from-pr` (each with a PR URL).
120+
# Step 4: Generate controller implementation
121+
/oape:api-implement https://github.com/openshift/enhancements/pull/1234
122+
123+
# Step 5: Generate e2e tests for your changes
124+
/oape:e2e-generate main
125+
```
101126

102127
### Adding a New Command
103128

0 commit comments

Comments
 (0)