Skip to content

docs: document Java dynamic dedup#839

Merged
officialasishkumar merged 19 commits intomainfrom
codex/java-dynamic-dedup-docs
Apr 27, 2026
Merged

docs: document Java dynamic dedup#839
officialasishkumar merged 19 commits intomainfrom
codex/java-dynamic-dedup-docs

Conversation

@officialasishkumar
Copy link
Copy Markdown
Member

@officialasishkumar officialasishkumar commented Apr 23, 2026

What has changed?

Documents Java dynamic deduplication as a dedup-only Java SDK flow across the versioned Java SDK pages.

This adds:

  • Java SDK setup for Enterprise dynamic dedup replay.
  • Explicit note that the Java SDK does not record API traffic or mocks.
  • Native and Docker keploy test --dedup commands.
  • Restricted Docker guidance for shared /tmp control/data sockets.
  • KEPLOY_JAVA_CLASS_DIRS guidance for custom layouts and faster replay.
  • CI guidance that Java dedup pipelines should use checked-in fixtures and should not record in CI.

The Java SDK now reads JaCoCo coverage in-process via the runtime API (org.jacoco.agent.rt.RT.getAgent()), so the docs no longer require launching JaCoCo in tcpserver mode or passing --pass-through-ports. The TCP server flow is documented as the automatic fallback, including KEPLOY_JACOCO_HOST / KEPLOY_JACOCO_PORT overrides.

Related issue: keploy/enterprise#1920
Related PRs: keploy/java-sdk#181, keploy/samples-java#130, keploy/enterprise#1912

Type of change

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

  • git diff --check.
  • Searched the updated Java pages for stale JaCoCo merge/keploy-e2e.exec instructions; no stale merge-flow terms remain.
  • Verified all Java dedup install pages and the dedup overview no longer require tcpserver mode or --pass-through-ports for the default flow, and the TCP fallback path is documented separately.

No docs site rebuild was run after this final versioned-docs update.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@officialasishkumar officialasishkumar marked this pull request as ready for review April 23, 2026 16:40
@officialasishkumar
Copy link
Copy Markdown
Member Author

Upstream tracking issue: keploy/enterprise#1920

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Update Java dedup install and deduplication pages across versions
  2.0.0, 3.0.0, and 4.0.0 to reflect the in-process JaCoCo API as the
  default coverage transport.
- Remove the requirement to launch JaCoCo in tcpserver mode and to
  pass --pass-through-ports for the JaCoCo port.
- Document the TCP server fallback for environments where the
  runtime API is unavailable, including KEPLOY_JACOCO_HOST and
  KEPLOY_JACOCO_PORT.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Replaces the N.N.N placeholders (and the leftover 0.0.1-SNAPSHOT in
  version-2.0.0/keploy-cloud/deduplication.md) across the v2/v3/v4
  Java SDK install pages with the 2.0.0 release version.
- End users on every documented Keploy version now see a copy-pasteable
  dependency block aligned with the first dedup-only Java SDK release.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@officialasishkumar officialasishkumar force-pushed the codex/java-dynamic-dedup-docs branch from d6cdd19 to 78b3fec Compare April 26, 2026 11:07
- Revert versioned_docs/version-2.0.0 deduplication.md and Java SDK install page to main.
- Revert versioned_docs/version-3.0.0 Java SDK install page to main.
- Keep Java dynamic dedup documentation only in version-4.0.0.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Reorder so the Golang section appears before the Java section.
- Promote bold subsection labels to H4 headings so each numbered step
  shows up in the right-side table of contents.
- Set toc_max_heading_level: 4 in the page front-matter so Docusaurus
  renders the new H4 anchors in the sidebar.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Revert numbered steps from H4 headings back to bold labels so the page
  matches the established pattern used elsewhere in the docs and the
  Golang section as it stood on main.
- Drop the toc_max_heading_level front-matter override.
- Keep the Golang-first section order so Java is documented underneath.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
- Convert numbered step labels (Pre-requisite, Build Configuration,
  Dockerfile Configuration, Run Deduplication) from bold paragraphs to
  H4 headings under both Golang and Java sections.
- Set toc_max_heading_level to 4 so the steps appear in the
  "On this page" sidebar, making the page easier to navigate.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
Keep the Java guide aligned with the released SDK and restore unrelated docs text.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@officialasishkumar officialasishkumar force-pushed the codex/java-dynamic-dedup-docs branch from eb4a18a to 88662c0 Compare April 27, 2026 20:13
@officialasishkumar officialasishkumar merged commit 6ef2e20 into main Apr 27, 2026
7 checks passed
@officialasishkumar officialasishkumar deleted the codex/java-dynamic-dedup-docs branch April 27, 2026 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants