Skip to content

feat: workflow step annotation - #853

Merged
octonato merged 2 commits into
workflow-step-methodsfrom
4093-workflow-stepname-annotation
Aug 4, 2025
Merged

octonato merged 2 commits into
workflow-step-methodsfrom
4093-workflow-stepname-annotation

Conversation

@aludwiko

@aludwiko aludwiko commented Aug 1, 2025

Copy link
Copy Markdown
Contributor

No description provided.

@aludwiko
aludwiko requested a review from octonato August 1, 2025 12:01
@aludwiko
aludwiko force-pushed the 4093-workflow-stepname-annotation branch from aa3202b to 04abcf0 Compare August 1, 2025 12:02
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WorkflowStep {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@ Step conflicts with akka.javasdk.workflow.Workflow.Step and @StepName is too narrow in my opinion.

@octonato octonato Aug 4, 2025 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

But the main goal here is to provide a name, no?
Therefore I think it makes sense to call it @StepName It's exactly about the name of the step.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, but sth tells me that we will use this annotation for other purposes later. Maybe not, that's why I'm not sure about the name.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You mean to add some extra configuration for the step?

I was thinking about it earlier. Some settings can be added to annotations, like max retries, but not a timeout duration or a step failover. So having some settings in annotation and others in code will create confusion. Better to stick with code only.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ok, changed, we should mention it in the docs.

@octonato octonato left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

πŸ‘

@octonato
octonato merged commit 8227aeb into workflow-step-methods Aug 4, 2025
@octonato
octonato deleted the 4093-workflow-stepname-annotation branch August 4, 2025 11:36
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.

2 participants