Skip to content

docs(java): document the expanded SDK surface#348

Merged
pratyush618 merged 2 commits into
masterfrom
docs/java-sdk-readme
Jul 1, 2026
Merged

docs(java): document the expanded SDK surface#348
pratyush618 merged 2 commits into
masterfrom
docs/java-sdk-readme

Conversation

@pratyush618

@pratyush618 pratyush618 commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

What

Updates sdks/java/README.md to document the SDK surface shipped since the last README refresh — everything now on master:

  • Baseline Java 17 (--release 17); Spring Boot 3 apps can adopt it.
  • Workflow engine: DAG, fan-out/fan-in, gates, conditions, sub-workflows, sagas, analysis/visualization, canvas.
  • Worker resources (DI), enqueue predicates, KEDA scaler endpoint, producer batching, in-process autoscaling.
  • Observability contrib (Micrometer Observation + Sentry) and MessagePack serializer — optional compileOnly deps.
  • Spring Boot 3 starter (org.byteveda:taskito-spring).

Docs-only; no code change.

Summary by CodeRabbit

  • Documentation
    • Updated the Java SDK README to reflect completed support for the SDK and a newer Java baseline.
    • Expanded the documented feature set to include additional workflow capabilities, batching, autoscaling, observability, and Spring Boot support.
    • Improved the package and project overview to better describe available modules and subprojects.

Baseline 17; workflow gates/conditions/sub-workflows/sagas/analysis/
visualization/canvas; resources, predicates, scaler, batching, autoscale,
observability contrib, MessagePack, and the Spring Boot starter.
@github-actions github-actions Bot added the docs label Jul 1, 2026
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 26 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ead2d4a6-6f0c-46c5-9351-e2655b6b36f1

📥 Commits

Reviewing files that changed from the base of the PR and between b973200 and d5eff5a.

📒 Files selected for processing (1)
  • sdks/java/README.md
📝 Walkthrough

Walkthrough

This PR updates the Java SDK README documentation, revising the supported Java baseline to 17, expanding the build-out status list, adding workflow-engine feature documentation, adding new Usage sections, and updating the package structure diagram and subprojects list.

Changes

README Documentation Update

Layer / File(s) Summary
Overview and status update
sdks/java/README.md
Java baseline updated from 11+ to 17+, with refreshed build-out status and feature bullets (MessagePack, worker resources, enqueue predicates, KEDA scaler endpoint, batching, autoscaling, observability, Spring Boot 3 starter).
Workflow feature documentation
sdks/java/README.md
Documents additional workflow constructs (approval gates, conditions, sub-workflows, sagas) and extends coverage of workflow analysis/visualization and canvas concepts.
Usage section additions
sdks/java/README.md
Adds new Usage subsections for worker resources (DI/scoping), enqueue predicates, producer batching, autoscaling and scaler endpoint, observability, MessagePack, and Spring Boot 3 starter configuration.
Package structure and subprojects update
sdks/java/README.md
Revises the package/module diagram to include error hierarchy and new feature packages, and updates the Subprojects list (:processor, :test-support, :spring, :graalvm-smoke).

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 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 summarizes the documentation update for the expanded Java SDK surface.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/java-sdk-readme

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@sdks/java/README.md`:
- Around line 6-16: The status blockquote in the Java README contains an empty
line that triggers markdownlint MD028. Update the README content in the status
section so the quoted lines stay contiguous, either by removing the blank line
or restructuring the blockquote, and keep the rest of the text unchanged.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9302e543-7d17-48d9-b9f9-cb41ef698e4a

📥 Commits

Reviewing files that changed from the base of the PR and between a2c0186 and b973200.

📒 Files selected for processing (1)
  • sdks/java/README.md

Comment thread sdks/java/README.md Outdated
@pratyush618 pratyush618 merged commit 6d0d260 into master Jul 1, 2026
18 checks passed
@pratyush618 pratyush618 deleted the docs/java-sdk-readme branch July 1, 2026 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant