Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_images/publish/publish-dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/publish/publish-initial.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/publish/publish-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/publish/publish-ready.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/publish/published-changes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/publish/published-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/publish/published-invalid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/publish/published.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/workflows/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@

1. On the version you want to restore or copy, select **Options** <span class="n8n-inline-image">![Options icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}</span>.
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.

Check warning on line 53 in docs/workflows/history.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-write-good.Passive] 'are protected' may be passive voice. Use active voice if you can. Raw Output: {"message": "[from-write-good.Passive] 'are protected' may be passive voice. Use active voice if you can.", "location": {"path": "docs/workflows/history.md", "range": {"start": {"line": 53, "column": 78}}}, "severity": "WARNING"}
47 changes: 41 additions & 6 deletions docs/workflows/publish.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Save, publish, and unpublish workflows.
description: Save, publish, unpublish, and name workflow versions.
contentType: howto
---

Expand All @@ -9,7 +9,7 @@

## 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 every 5 seconds while you edit. No manual save button is required. All edits remain in draft until you publish.

Check warning on line 12 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-write-good.Passive] 'is required' may be passive voice. Use active voice if you can. Raw Output: {"message": "[from-write-good.Passive] 'is required' may be passive voice. Use active voice if you can.", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 12, "column": 82}}}, "severity": "WARNING"}

## How publishing works

Expand All @@ -35,6 +35,10 @@

![](/_images/publish/published-changes.png)

**Published, invalid changes** The workflow is published, but there it's not in state to be republished (i.e. not trigger that requires publishing).

Check warning on line 38 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [n8n-styles.ie] Consider replacing 'i.e' with 'in other words' Raw Output: {"message": "[n8n-styles.ie] Consider replacing 'i.e' with 'in other words'", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 38, "column": 106}}}, "severity": "WARNING"}

Check failure on line 38 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-microsoft.Foreign] Use 'that is' instead of 'i.e. '. Raw Output: {"message": "[from-microsoft.Foreign] Use 'that is' instead of 'i.e. '.", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 38, "column": 106}}}, "severity": "ERROR"}

Check warning on line 38 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-write-good.Passive] 'be republished' may be passive voice. Use active voice if you can. Raw Output: {"message": "[from-write-good.Passive] 'be republished' may be passive voice. Use active voice if you can.", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 38, "column": 90}}}, "severity": "WARNING"}

Check warning on line 38 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-write-good.Passive] 'is published' may be passive voice. Use active voice if you can. Raw Output: {"message": "[from-write-good.Passive] 'is published' may be passive voice. Use active voice if you can.", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 38, "column": 45}}}, "severity": "WARNING"}

![](/_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)
Expand All @@ -50,32 +54,63 @@

## 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 displayed on the card.

Check warning on line 57 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-write-good.Passive] 'is published' may be passive voice. Use active voice if you can. Raw Output: {"message": "[from-write-good.Passive] 'is published' may be passive voice. Use active voice if you can.", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 57, "column": 42}}}, "severity": "WARNING"}

![](/_images/publish/published-indicator-wf-list.png)

## Publishing a workflow

The **Publish** button in the canvas header is enabled whenever there are unpublished changes.

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** <span class="n8n-inline-image">![Options icon](/_images/common-icons/three-dot-options-menu.png){.off-glb}</span>.
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:

* 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
## Unpublishing a workflow

Check failure on line 110 in docs/workflows/publish.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Unpublishing'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Unpublishing'?", "location": {"path": "docs/workflows/publish.md", "range": {"start": {"line": 110, "column": 4}}}, "severity": "ERROR"}

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)