diff --git a/docs/_images/publish/publish-dropdown.png b/docs/_images/publish/publish-dropdown.png new file mode 100644 index 00000000000..1a94a6d50f6 Binary files /dev/null and b/docs/_images/publish/publish-dropdown.png differ diff --git a/docs/_images/publish/publish-initial.png b/docs/_images/publish/publish-initial.png index f4287ab61ef..7e75fcd5942 100644 Binary files a/docs/_images/publish/publish-initial.png and b/docs/_images/publish/publish-initial.png differ diff --git a/docs/_images/publish/publish-modal.png b/docs/_images/publish/publish-modal.png new file mode 100644 index 00000000000..1b5b4794076 Binary files /dev/null and b/docs/_images/publish/publish-modal.png differ diff --git a/docs/_images/publish/publish-ready.png b/docs/_images/publish/publish-ready.png index 4d4dce3e426..67180df0edf 100644 Binary files a/docs/_images/publish/publish-ready.png and b/docs/_images/publish/publish-ready.png differ diff --git a/docs/_images/publish/published-changes.png b/docs/_images/publish/published-changes.png index 0bb5e6cd510..5380e84da25 100644 Binary files a/docs/_images/publish/published-changes.png and b/docs/_images/publish/published-changes.png differ diff --git a/docs/_images/publish/published-error.png b/docs/_images/publish/published-error.png index a63fcf4b686..62416548ab4 100644 Binary files a/docs/_images/publish/published-error.png and b/docs/_images/publish/published-error.png differ diff --git a/docs/_images/publish/published-indicator-wf-list.png b/docs/_images/publish/published-indicator-wf-list.png new file mode 100644 index 00000000000..2b5a85ba87d Binary files /dev/null and b/docs/_images/publish/published-indicator-wf-list.png differ diff --git a/docs/_images/publish/published-invalid.png b/docs/_images/publish/published-invalid.png new file mode 100644 index 00000000000..783c9274c41 Binary files /dev/null and b/docs/_images/publish/published-invalid.png differ diff --git a/docs/_images/publish/published.png b/docs/_images/publish/published.png index 06a1c9afcaa..7cf5a4b8484 100644 Binary files a/docs/_images/publish/published.png and b/docs/_images/publish/published.png differ diff --git a/docs/workflows/history.md b/docs/workflows/history.md index bfe10cc403e..d33f219613c 100644 --- a/docs/workflows/history.md +++ b/docs/workflows/history.md @@ -46,7 +46,8 @@ You can restore a previous workflow version, or make a copy of it: 1. On the version you want to restore or copy, select **Options** ![Options icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}. 1. Choose what you want to do: - * **Restore this version**: replace your current workflow with the selected version. + * **Restore version**: replace your current workflow with the selected version. * **Clone to new workflow**: create a new workflow based on the selected version. * **Open version in new tab**: open a second tab displaying the selected version. Use this to compare versions. * **Download**: download the version as JSON. + * **Name version**: give the version a name and description. Named versions are protected from automatic pruning. Refer to [Naming versions](/workflows/publish.md#naming-versions) for more details. Available on Pro and Enterprise plans. diff --git a/docs/workflows/publish.md b/docs/workflows/publish.md index a3c28664d4b..99e4b01ff9e 100644 --- a/docs/workflows/publish.md +++ b/docs/workflows/publish.md @@ -1,15 +1,15 @@ --- -description: Save, publish, and unpublish workflows. +description: Save, publish, unpublish, and name workflow versions. contentType: howto --- # Saving and publishing workflows -n8n automatically saves your workflow changes every 5 seconds while you're editing. When you're ready to put the workflow into production, publish your workflow. This approach prevents accidental production changes while enabling safe iteration and review. +n8n auto saves your workflow while you're editing. When you're ready to put the workflow into production, publish your workflow. This approach prevents accidental production changes while enabling safe iteration and review. ## How saving works -Changes save automatically every 5 seconds while you edit. No manual save button is required, though you can still use Ctrl+S or Cmd+S if preferred. All edits remain in draft until you publish. +Changes save automatically as you edit, typically within 1 to 5 seconds. No manual save button is required. All edits remain in draft until you publish. ## How publishing works @@ -35,6 +35,10 @@ Publishing makes your workflow live and locks it to a specific version. Producti ![](/_images/publish/published-changes.png) +**Published, invalid changes** The workflow is published, but it's not in a state to be republished (no trigger requires publishing). + +![](/_images/publish/published-invalid.png) + **Published, error** The workflow is published, but there are errors in your recent changes that need to be fixed before you can publish again. ![](/_images/publish/published-error.png) @@ -50,7 +54,9 @@ Only one person can edit a workflow at a time. If someone else is currently edit ## Checking publishing status -On the **Workflows** page, each workflow displays an indicator showing whether it is **Published** or **Not Published**. You will also be able to see the same indicator on the canvas header. +On the **Workflows** page, if a workflow is published an indicator will be displayed on the card. + +![](/_images/publish/published-indicator-wf-list.png) ## Publishing a workflow @@ -58,12 +64,40 @@ The **Publish** button in the canvas header is enabled whenever there are unpubl Each time you make a change to a workflow, n8n autosaves those changes to a new version of the workflow. These saved versions go live in production only when you publish the workflow after the changes. -1. Click the **Publish** button to open the publishing modal +1. Click the **Publish** button (or use hotkey `Shift` + `p`) to open the publishing modal 2. The version name defaults to a UUID. Customize the name if you'd like and add a description of the version. 3. Click **Publish** to make your changes live in production. Production executions always point to the currently published version. If you only update workflow settings, n8n will re-publish the version without requiring you to take any action. +![](/_images/publish/publish-modal.png) + + +## Naming versions + +/// info | Feature availability +Named versions are available on Pro and Enterprise Cloud plans, and Enterprise self-hosted plans. +/// + +Named versions let you give a meaningful name and description to any workflow version. This helps you identify important milestones in your workflow's development. Named versions are also protected from automatic [version history pruning](/workflows/history.md), so they persist indefinitely. + +To name a version from the canvas header: + +1. Select the dropdown arrow next to the **Publish** button (or use hotkey `Cmd/Ctrl` + `s`). +2. Select **Name version**. +3. Enter a name and optional description. +4. Select **Save**. + +![](/_images/publish/publish-dropdown.png) + +To name a version from the version history page: + +1. Open the version history by selecting the history icon in the header. +2. On the version you want to name, select **Options** ![Options icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}. +3. Select **Name version**. +4. Enter a name and optional description. +5. Select **Save**. + ## Managing version history View and manage version history by clicking the history icon in the header. In the version history view, you can perform these actions: @@ -71,11 +105,12 @@ View and manage version history by clicking the history icon in the header. In t * Unpublish the workflow to remove it from production * Restore a previous version. Restoring lets you work on a version without affecting the production execution. * Publish another version of the workflow +* Name a version to protect it from pruning -## Unpublishing a Workflow +## How to unpublish a workflow Unpublish a workflow from either: -- The workflow settings menu +- The dropdown arrow next to the **Publish** button in the canvas header (or use hotkey `Cmd/Ctrl` + `u`). - In the workflow list - The version history page (unpublish action on published versions)