Skip to content

Commit 0bb8a91

Browse files
docs(k8s-proxy): remove local CI replay section
Drop the Local CI replay point from the v4.0.0 k8s proxy API docs to keep the page aligned with the requested scope. Made-with: Cursor Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
1 parent 3ac6ae4 commit 0bb8a91

1 file changed

Lines changed: 0 additions & 24 deletions

File tree

versioned_docs/version-4.0.0/running-keploy/k8s-proxy-api.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -96,30 +96,6 @@ Current auto-replay already performs the in-session curation work:
9696

9797
Combined with capture-time static deduplication (benefit 2), this keeps the current replay set small, stable, and CI-gateable even when the underlying traffic is noisy.
9898

99-
### 6. Local CI replay
100-
101-
> **Status:**
102-
>
103-
> - **The replay step itself:** Shipped for any CI provider. It is invoked through the `keploy test sandbox` CLI, which runs unchanged on GitHub Actions, GitLab CI, CircleCI, Jenkins, Bitbucket Pipelines, Azure Pipelines, or a self-hosted runner.
104-
> - **Auto-generated workflow YAML:** Shipped for **GitHub Actions** via the MCP `scaffold_pipeline_workflow` tool. Native scaffolds for other CI providers are upcoming. Until then, the GitHub Actions workflow can be hand-ported because the replay command and its flags are identical across providers, and only the surrounding CI syntax changes.
105-
106-
Local CI replay runs your Keploy test suites against a fresh build of your service _inside the CI runner_, on every pull request. Docker Compose brings the service's dependencies up; the Keploy enterprise CLI starts the service itself under instrumentation, replays each recorded request, serves the recorded mocks for every outbound dependency call, and byte-compares the live response against the captured one. The aggregated pass/fail becomes the PR gate.
107-
108-
The "local" qualifier distinguishes this path from the SaaS replay path (`run_and_report`), which targets a publicly reachable URL such as staging and rejects local-only URLs. Local CI replay targets `http://localhost:$APP_PORT` inside the runner, so the thing under test is the code on the pull request branch, not staging.
109-
110-
The generated workflow performs the following steps:
111-
112-
1. Checks out the repository and installs the Keploy enterprise CLI.
113-
2. Brings the Docker Compose stack up with `docker compose up -d --wait`, then stops and removes the application service so the CLI can start it under instrumentation.
114-
3. Runs `keploy test sandbox` with the appropriate flags, including `--create-branch "${{ github.head_ref }}"`. Keploy branches use find-or-create semantics: the first run on a pull request creates a Keploy branch named after the git branch, and subsequent retries reuse it. The workflow is therefore idempotent across force-pushes.
115-
4. Uploads `keploy/reports` as a workflow artifact on every run, including failures.
116-
5. Dumps Docker Compose logs on failure.
117-
6. Tears the Compose stack down.
118-
119-
The pre-flight check counts how many sandbox suites are linked to the app. When zero suites are linked, the scaffold response warns you before you add the workflow; the CLI run itself expects linked sandbox suites and will fail until suites are created. The generated YAML is annotated `# Auto-generated by keploy scaffold_pipeline_workflow: edit freely` and can be modified or extended without losing the ability to regenerate.
120-
121-
---
122-
12399
## Authentication
124100

125101
:::info In development

0 commit comments

Comments
 (0)