Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for providing custom Tags when starting workflows #400

Open
bowersj27 opened this issue Jul 2, 2024 · 0 comments
Open

Support for providing custom Tags when starting workflows #400

bowersj27 opened this issue Jul 2, 2024 · 0 comments

Comments

@bowersj27
Copy link
Contributor

bowersj27 commented Jul 2, 2024

Support for providing custom Tags when starting workflows

Description

It would be beneficial to support custom tagging of workflows when starting in iwf. This enhancement would enable better categorization and search-ability of workflows.

Proposed Solution

  1. Add New Field in WorkflowStartOptions:

    • Introduce a new field tags as a list of strings in the WorkflowOptions.
    • Example update in the Java SDK:
      public abstract List<String> getTags();

    A new field in WorkflowOptions here will be available for clients to set custom tags.

  2. Update IWF Namespaces:

    • Ensure all provisioned iwf namespaces include a new search attribute ex: iwfCustomTag of type Keyword Array that these tags can be mapped to where provisioning occurs(ex: iwf integration tests).

Impact

  • Enhances the flexibility and manageability of workflows.
  • Facilitates easier and more efficient searching and categorizing of workflows.
    • This idea is derived from a request to be able to tag workflows created during testing of a iwf use-case that can easily be searched and cleaned up within a namespace when all tests have finished.

Expected Changes

  1. API Changes:

    • Update the start API to accept tags as part of the WorkflowStartOptions.
  2. SDK Updates:

    • Update all relevant SDKs to support the new tags field.
@bowersj27 bowersj27 changed the title Support for providing custom Labels when starting workflows Support for providing custom Tags when starting workflows Jan 13, 2025
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

No branches or pull requests

1 participant