specification icon indicating copy to clipboard operation
specification copied to clipboard

Enforce action name

Open JBBianchi opened this issue 3 years ago • 5 comments

What would you like to be added: The name of actions to be required.

Why is this needed: The name is a human, comprehensible way of working. When reviewing the activities of a workflow, knowing that "Action[2]" was a success doesn't really speak to the user. It requires to have the definition under the eyes, count the actions to find the one we are speaking about. Having it named will improve readability and maintainability of workflows and their activities.

JBBianchi avatar Sep 19 '22 08:09 JBBianchi

+1

But honestly, implementations can compose the action description using the definition of the given action. But I agree that a required name could be more accessible for debug purposes.

ricardozanini avatar Sep 19 '22 12:09 ricardozanini

This is done i believe as part of the error handling updates pr.

tsurdilo avatar Sep 19 '22 14:09 tsurdilo

This also applies to other item types like branch.

A name should be unique within the scope of its parent but not the whole workflow.

JBBianchi avatar Sep 19 '22 15:09 JBBianchi

As agreed in the meeting call, within the same state, we should guarantee action uniqueness

ricardozanini avatar Sep 19 '22 15:09 ricardozanini

Yes branch names are also going to be enforced as part of error handling updates.

tsurdilo avatar Sep 21 '22 12:09 tsurdilo

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Nov 08 '22 00:11 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Dec 30 '22 00:12 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Feb 17 '23 00:02 github-actions[bot]

Seems this suggested hasn't moved to the specification yet. Should we update the spec?

jaliyaudagedara avatar Mar 09 '23 07:03 jaliyaudagedara

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Apr 25 '23 00:04 github-actions[bot]