Skip to content

Add best practices documentation for workflow development - #724

Merged
ricardozanini merged 1 commit into
quarkiverse:mainfrom
mcruzdev:issue-723
Aug 7, 2026
Merged

Add best practices documentation for workflow development#724
ricardozanini merged 1 commit into
quarkiverse:mainfrom
mcruzdev:issue-723

Conversation

@mcruzdev

@mcruzdev mcruzdev commented Jul 3, 2026

Copy link
Copy Markdown
Member

Description

Covers four common pitfalls: using @Transactional for persistence instead of manual QuarkusTransaction, referencing secrets via handles instead of hard-coding credentials, naming tasks explicitly for observability, and separating business retries (tryCatch with retry) from infrastructure retries (Fault Tolerance config properties).

Fixes #723

Testing

Test Plan

  • Unit tests added/updated
  • Integration tests added/updated (if applicable)
  • Tested manually (describe below if applicable)

Manual Testing

Checklist

Before submitting this PR, please ensure:

  • I ran the full build with integration tests locally: ./mvnw clean install -DskipITs=false
  • Code follows the project's code conventions
  • Tests have been added/updated to cover the changes
  • Documentation has been updated (if user-facing changes)
  • Commit messages are clear and follow conventional commits style
  • I have read and followed the Contributing Guide
  • I have read and comply with the LLM Usage Policy (if applicable)

Additional Notes

@mcruzdev
mcruzdev requested a review from a team as a code owner July 3, 2026 18:10
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown

🙈 The PR is closed and the preview is expired.

Comment thread docs/modules/ROOT/examples/org/acme/bestpractices/NotificationWorkflowGood.java Outdated
Comment thread docs/modules/ROOT/pages/best-practices.adoc Outdated
Comment thread docs/modules/ROOT/pages/best-practices.adoc Outdated
Comment thread docs/modules/ROOT/pages/best-practices.adoc Outdated
@mcruzdev
mcruzdev requested a review from ricardozanini August 4, 2026 21:01
Comment thread docs/modules/ROOT/examples/org/acme/bestpractices/NotificationWorkflowGood.java Outdated
@ricardozanini

Copy link
Copy Markdown
Member

@mcruzdev can you please check the CI errors?

@ricardozanini ricardozanini left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One small thign and we are good to go.

Comment thread docs/modules/ROOT/examples/org/acme/bestpractices/NotificationWorkflowBad.java Outdated
Comment thread docs/modules/ROOT/examples/org/acme/bestpractices/NotificationWorkflowBad.java Outdated
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
@ricardozanini
ricardozanini merged commit 9402dd3 into quarkiverse:main Aug 7, 2026
15 checks passed
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

📊 Quarkus Flow Coverage Report

There is no coverage information present for the Files changed

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.

docs: Document Quarkus Flow best practices

2 participants