Skip to content

docs(#747): update java client documentation - #9

Open
triskill wants to merge 1 commit into
mainfrom
fux/747-fix-java-client-documentation
Open

docs(#747): update java client documentation#9
triskill wants to merge 1 commit into
mainfrom
fux/747-fix-java-client-documentation

Conversation

@triskill

@triskill triskill commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Updated release documentation for version 1.5.0.
    • Added tested Spring Boot 3 examples covering Maven setup, configuration, REST deployment, process starts, job workers, and BPMN output mappings.
    • Documented Java/Spring compatibility, gRPC requirements, release workflows, and security guidance for logging.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bb2f1bd8-de5c-47cb-aaa1-9209dece6c92

📥 Commits

Reviewing files that changed from the base of the PR and between b3e9662 and c9b82a9.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md was updated for release 1.5.0 with Java and Spring compatibility, build requirements, configuration, REST and gRPC examples, worker behavior, BPMN mappings, release workflow, and logging guidance.

Changes

README documentation update

Layer / File(s) Summary
Setup and release documentation
README.md
The README documents generated artifacts, gRPC channel-provider requirements, Java and Maven setup, Java 17 and Spring Boot 3 compatibility, dependencies, and the 1.5.0 release workflow.
Configuration and REST examples
README.md
The README adds tested kebab-case configuration and a Spring service that deploys BPMN files, starts process instances, and retrieves them.
Worker and BPMN flow examples
README.md
The README documents a discovered EmailWorker and a BPMN service-task flow with retries, output mappings, deployment, and completion.

Estimated code review effort: 2 (Simple) | ~10 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 clearly and concisely describes the README documentation updates for the Java client.
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 fux/747-fix-java-client-documentation

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

@triskill
triskill marked this pull request as ready for review August 12, 2026 07:13

@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 `@README.md`:
- Line 120: Update the logging guidance in README.md to state that this sample
explicitly disables client logging and instructs users to set both
restLoggingEnabled and grpcLoggingEnabled to false in production. Clarify that
REST BODY logging and gRPC TRACE logging can expose process variables and
results, while preserving the existing BASIC/TRACE distinctions.
🪄 Autofix

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: bdf7326e-aa83-4a36-b8bb-1d16f113cac8

📥 Commits

Reviewing files that changed from the base of the PR and between b954748 and b3e9662.

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

Comment thread README.md Outdated
@triskill
triskill force-pushed the fux/747-fix-java-client-documentation branch from b3e9662 to c9b82a9 Compare August 12, 2026 13:39
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.

1 participant