Skip to main content

Best Practices

Workflow Design​

  1. Start Simple: Begin with linear workflows, add complexity gradually
  2. Clear Naming: Use descriptive names for steps and parameters
  3. Error Handling: Always define error handling strategies
  4. Documentation: Use clear descriptions for workflows and steps
  5. Observability: Use file logged in /observe to debug and build your workflows

Step Design​

  1. Single Responsibility: Each step should have one clear purpose
  2. Run Limits: Set appropriate runLimit values to prevent infinite loops

Template Variables​

  1. Type Safety: Be aware of data types when using templates
  2. Observability: Use file logged in /observe to debug and build your workflows

Error Handling​

  1. Graceful Degradation: Design workflows to handle partial failures
  2. Retry Logic: Use appropriate retry strategies for different error types
  3. Workflow Special Actions: Use special keyworkds like 'stop-workflow', 'retry-step', ...

Performance​

  1. Parallel Execution: Use multiple next steps for parallel processing
  2. Bottleneck Analysis: Use observability data to identify bottlenecks

Security​

  1. Secret Management: Use the secret management system for sensitive data, keyvault will be available soon.
  2. Least Privilege: Grant minimal permissions to addons credentials