ReferenceWorkflow Steps
Annotation Step
Add human-readable progress notes to the workflow timeline.
Configuration
interface AnnotationStepConfig {
message: string;
}Timeout: Instant
Usage
await step.annotation("start", {
message: "Starting deployment to production 🚀",
});
await step.annotation("progress", {
message: "Build completed. Running tests...",
});
await step.annotation("complete", {
message: "Deployment successful! ✓",
});Best Practices
- Use at phase transitions
- Explain what's happening
- Celebrate wins with emoji
- Mark errors clearly