Workflow descriptions moved to document store
The description field has been migrated out of the monolithic workflows.store into the dedicated workflowDocument store composable system, consolidating state management for workflow properties.
The workflows.store had grown to hold state for many workflow properties, including description. Rather than continuing to mix document-level state with workflow execution state, description is now managed through the same composable pattern already used by tags, meta, settings, and other document properties.
Components that need the workflow description — MainHeader and ActionsDropdownMenu — now read from the injected workflowDocumentStore instead of the raw workflow object. The saveWorkflowDescription logic moved into WorkflowDescriptionModal where it belongs, handling version checks and cache updates for both the current workflow and workflows from the list store.
This cleanup removes the setDescription export from workflows.store and aligns description handling with the established pattern for other document properties.
View Original GitHub Description
Summary
Migrates the description field from the monolithic workflows.store into the workflowDocument store composable system, making workflowDocumentStore.description the single source of truth. This follows the same pattern used by tags, meta, settings, and other document properties.
Changes:
- Created
useWorkflowDocumentDescriptioncomposable (ref + event hook pattern matchinguseWorkflowDocumentMeta) - Wired the composable into
workflowDocument.store.ts - Moved description initialization from
workflowsStore.setDescription()toinitializedWorkflowDocumentStore.setDescription()ininitState() - Updated
saveWorkflowDescriptioninworkflows.storeto write to the document store - Removed
setDescriptionfromworkflows.storeexports - Updated
MainHeader.vueandActionsDropdownMenu.vueto read description from the document store
Related Linear tickets, Github issues, and Community forum posts
https://linear.app/n8n/issue/CAT-2740
Review / Merge checklist
- PR title and summary are descriptive. (conventions)
- Docs updated or follow-up ticket created.
- Tests included.