Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`n8n project user role`](n8n_project_user_role.md) | Manage members' project roles |
| [`n8n project user`](n8n_project_user.md) | Manage project members |
| [`n8n project`](n8n_project.md) | Manage projects and their members |
| [`n8n promotion apply-continue`](n8n_promotion_apply-continue.md) | Continue a reviewed connection apply after binding setup |
| [`n8n promotion apply`](n8n_promotion_apply.md) | Apply the Git remote into this instance |
| [`n8n promotion checkout clone`](n8n_promotion_checkout_clone.md) | Clone one promotion checkout locally |
| [`n8n promotion checkout disconnect`](n8n_promotion_checkout_disconnect.md) | Remove one promotion checkout |
Expand All @@ -143,14 +144,20 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`n8n promotion connection update`](n8n_promotion_connection_update.md) | Update a promotion connection |
| [`n8n promotion connection`](n8n_promotion_connection.md) | Manage promotion connections |
| [`n8n promotion project add`](n8n_promotion_project_add.md) | Add a project to a promotion connection |
| [`n8n promotion project apply-continue`](n8n_promotion_project_apply-continue.md) | Continue a reviewed project apply after binding setup |
| [`n8n promotion project apply`](n8n_promotion_project_apply.md) | Apply selected workflow changes from a project's branch |
| [`n8n promotion project changes`](n8n_promotion_project_changes.md) | List workflow changes for a project's promotion branch |
| [`n8n promotion project list`](n8n_promotion_project_list.md) | List projects linked to a promotion connection |
| [`n8n promotion project promote`](n8n_promotion_project_promote.md) | Promote selected project workflows to the remote branch |
| [`n8n promotion project remove`](n8n_promotion_project_remove.md) | Remove a project from a promotion connection |
| [`n8n promotion project`](n8n_promotion_project.md) | Manage projects linked to a promotion connection |
| [`n8n promotion promote`](n8n_promotion_promote.md) | Promote team projects to the Git remote |
| [`n8n promotion provider branches`](n8n_promotion_provider_branches.md) | List branches of a GitLab repository |
| [`n8n promotion provider create`](n8n_promotion_provider_create.md) | Create a promotion provider |
| [`n8n promotion provider delete`](n8n_promotion_provider_delete.md) | Permanently delete a promotion provider |
| [`n8n promotion provider get`](n8n_promotion_provider_get.md) | Show one promotion provider |
| [`n8n promotion provider list`](n8n_promotion_provider_list.md) | List promotion providers |
| [`n8n promotion provider repositories`](n8n_promotion_provider_repositories.md) | List repositories available to a GitLab provider |
| [`n8n promotion provider update`](n8n_promotion_provider_update.md) | Update a promotion provider |
| [`n8n promotion provider`](n8n_promotion_provider.md) | Manage promotion providers |
| [`n8n promotion`](n8n_promotion.md) | Manage promotion providers, connections, and apply/promote sync |
Expand Down
7 changes: 5 additions & 2 deletions docs/n8n_promotion.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ Manage promotion providers, connections, and apply/promote sync

### Synopsis

Manage the upstream-only Promotions generation of Git sync.
Manage Promotions Git sync and selected project workflows.
Start with 'provider list' to find a provider, then 'connection list'
to find a connection. Create a provider first, then a connection on
it, then a config per direction under 'config', clone each checkout
under 'checkout', link team projects to a projects-scope connection
under 'project', then 'promote' the instance to the remote or 'apply'
the remote into the instance.
the remote into the instance. For selected workflows, start with
project changes, then project apply or project promote. Use apply-continue
after resolving a blocked apply.

'promote' and 'apply' run on the instance connection. 'promote'
commits and pushes every team project to the remote; 'apply' checks the
Expand Down Expand Up @@ -50,6 +52,7 @@ n8n promotion [flags]

* [n8n](n8n.md) - Command-line client for the n8n API
* [n8n promotion apply](n8n_promotion_apply.md) - Apply the Git remote into this instance
* [n8n promotion apply-continue](n8n_promotion_apply-continue.md) - Continue a reviewed connection apply after binding setup
* [n8n promotion checkout](n8n_promotion_checkout.md) - Manage promotion checkouts
* [n8n promotion config](n8n_promotion_config.md) - Manage promotion direction configs
* [n8n promotion connection](n8n_promotion_connection.md) - Manage promotion connections
Expand Down
61 changes: 61 additions & 0 deletions docs/n8n_promotion_apply-continue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## n8n promotion apply-continue

Continue a reviewed connection apply after binding setup

### Synopsis

Continue a full instance-connection apply after resolving its preflight items.
Start with 'n8n promotion apply CONNECTION_ID --output json'. The apply
checkout must be cloned. Every team project is synchronized: workflows,
folders, credentials, tables, variables, and tags can change or be removed.
Requires gitConnection:pull and the same permissions as the initial apply.
Use --expected-from FILE|- with changes JSON or a blocked apply result,
or supply all three --expected-config-id, --expected-branch, --expected-commit
flags (full lowercase 40- or 64-digit hex SHA). A null commit cannot be used.
Expected source is required; use the blocked result's configId and git.
The server keeps no session and provides no exactly-once guarantee.
--confirm-destructive-changes permits removal or retyping of data-table
columns and loss of their values; rows and other columns remain.
It also permits deleting team projects with everything in them.
This covers every such change at continue time, including changes absent
from the reviewed result.
Exit codes: 0 applied, 3 blocked, 4 source-changed, 1 other error. Only
applied writes content. Resolve blocked bindings before apply-continue;
review source-changed results again. JSON prints the full status result;
text shows preflight details or counts and warnings. Hints go to stderr.
Read request JSON with --input FILE|- (maximum 1 MiB). Input and document flags are
mutually exclusive. Interactive runs ask for confirmation; non-interactive
runs and stdin input require --yes. JSON returns the server result; text
shows counts and the commit after success.

```
n8n promotion apply-continue <connection-id> [flags]
```

### Examples

```
n8n promotion apply-continue CONNECTION_ID --expected-from blocked.json
n8n promotion apply-continue CONNECTION_ID --input request.json --yes --output json
```

### Options

```
--confirm-destructive-changes allow all destructive changes at continue time, including unreviewed column value loss and, for full apply, team-project deletion (default: false)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--expected-branch string reviewed branch name (default: omitted; requires expected config ID and commit)
--expected-commit string reviewed lowercase full 40- or 64-digit hex commit SHA (default: omitted; requires expected config ID and branch)
--expected-config-id string reviewed config ID, 1 to 36 characters (default: omitted; requires expected branch and commit)
--expected-from string changes or blocked-apply JSON file, or - for stdin (default: explicit expected-source flags; stdin requires --yes)
-h, --help help for apply-continue
--input string request JSON file path or - for stdin, maximum 1 MiB (default: use document flags; stdin requires --yes)
--output string output format: text or json (default: text; JSON is the full server result) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--yes confirm content changes without prompting (default: prompt; required for non-interactive or stdin input)
```

### SEE ALSO

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync

9 changes: 8 additions & 1 deletion docs/n8n_promotion_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@ A project can belong to only one connection, so adding a linked
project elsewhere answers 409. Removing unlinks the project; its
instance content is untouched. Project IDs come from 'n8n project
list'. Adding and listing need gitConnection:read for reads and
gitConnection:manageProjects for writes.
gitConnection:manageProjects for writes. For selected workflow sync,
start with changes PROJECT_ID apply|promote, then apply or promote.
Selection commands take a project ID first and resolve its own connection
before falling back to the instance connection.

```
n8n promotion project [flags]
Expand All @@ -38,6 +41,10 @@ n8n promotion project [flags]

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync
* [n8n promotion project add](n8n_promotion_project_add.md) - Add a project to a promotion connection
* [n8n promotion project apply](n8n_promotion_project_apply.md) - Apply selected workflow changes from a project's branch
* [n8n promotion project apply-continue](n8n_promotion_project_apply-continue.md) - Continue a reviewed project apply after binding setup
* [n8n promotion project changes](n8n_promotion_project_changes.md) - List workflow changes for a project's promotion branch
* [n8n promotion project list](n8n_promotion_project_list.md) - List projects linked to a promotion connection
* [n8n promotion project promote](n8n_promotion_project_promote.md) - Promote selected project workflows to the remote branch
* [n8n promotion project remove](n8n_promotion_project_remove.md) - Remove a project from a promotion connection

65 changes: 65 additions & 0 deletions docs/n8n_promotion_project_apply-continue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## n8n promotion project apply-continue

Continue a reviewed project apply after binding setup

### Synopsis

Start with 'n8n promotion project changes PROJECT_ID apply' to review workflow IDs.
The project's own connection resolves first, otherwise the instance connection.
The apply direction must be cloned. Selected IDs on the branch are imported;
selected workflows owned by this project whose IDs are absent from the branch
are removed. Unselected content stays unchanged. Duplicate or invalid IDs
reject the whole request. Requires gitConnection:pull.
Use --expected-from FILE|- with changes JSON or a blocked apply result,
or supply all three --expected-config-id, --expected-branch, --expected-commit
flags (full lowercase 40- or 64-digit hex SHA). A null commit cannot be used.
Expected source is required; use the blocked result's configId and git.
The server keeps no session and provides no exactly-once guarantee.
Resend the same full workflow ID selection used for the initial apply.
--confirm-destructive-changes permits removal or retyping of data-table
columns and loss of their values; rows and other columns remain.
This covers every such change at continue time, including changes absent
from the reviewed result.
Exit codes: 0 applied, 3 blocked, 4 source-changed, 1 other error. Only
applied writes content. Resolve blocked bindings before apply-continue;
review source-changed results again. JSON prints the full status result;
text shows preflight details or counts and warnings. Hints go to stderr.

Pass repeated --workflow-id flags, or use a strict JSON request.
Read request JSON with --input FILE|- (maximum 1 MiB). Input and document flags are
mutually exclusive. Interactive runs ask for confirmation; non-interactive
runs and stdin input require --yes. JSON returns the server result; text
shows counts and the commit after success.

```
n8n promotion project apply-continue <project-id> [flags]
```

### Examples

```
n8n promotion project apply-continue PROJECT_ID --workflow-id WORKFLOW_ID --expected-from blocked.json
n8n promotion project apply-continue PROJECT_ID --input request.json --yes --output json
```

### Options

```
--confirm-destructive-changes allow all destructive changes at continue time, including unreviewed column value loss and, for full apply, team-project deletion (default: false)
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--expected-branch string reviewed branch name (default: omitted; requires expected config ID and commit)
--expected-commit string reviewed lowercase full 40- or 64-digit hex commit SHA (default: omitted; requires expected config ID and branch)
--expected-config-id string reviewed config ID, 1 to 36 characters (default: omitted; requires expected branch and commit)
--expected-from string changes or blocked-apply JSON file, or - for stdin (default: explicit expected-source flags; stdin requires --yes)
-h, --help help for apply-continue
--input string request JSON file path or - for stdin, maximum 1 MiB (default: use document flags; stdin requires --yes)
--output string output format: text or json (default: text; JSON is the full server result) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--workflow-id stringArray selected workflow ID, 1 to 36 characters; repeat for each ID (default: none; required unless --input is used)
--yes confirm content changes without prompting (default: prompt; required for non-interactive or stdin input)
```

### SEE ALSO

* [n8n promotion project](n8n_promotion_project.md) - Manage projects linked to a promotion connection

58 changes: 58 additions & 0 deletions docs/n8n_promotion_project_apply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
## n8n promotion project apply

Apply selected workflow changes from a project's branch

### Synopsis

Start with 'n8n promotion project changes PROJECT_ID apply' to review workflow IDs.
The project's own connection resolves first, otherwise the instance connection.
The apply direction must be cloned. Selected IDs on the branch are imported;
selected workflows owned by this project whose IDs are absent from the branch
are removed. Unselected content stays unchanged. Duplicate or invalid IDs
reject the whole request. Requires gitConnection:pull.
Use --expected-from FILE|- with changes JSON or a blocked apply result,
or supply all three --expected-config-id, --expected-branch, --expected-commit
flags (full lowercase 40- or 64-digit hex SHA). A null commit cannot be used.
Expected source is optional; supply it to detect changes after review.
Exit codes: 0 applied, 3 blocked, 4 source-changed, 1 other error. Only
applied writes content. Resolve blocked bindings before apply-continue;
review source-changed results again. JSON prints the full status result;
text shows preflight details or counts and warnings. Hints go to stderr.

Pass repeated --workflow-id flags, or use a strict JSON request.
Read request JSON with --input FILE|- (maximum 1 MiB). Input and document flags are
mutually exclusive. Interactive runs ask for confirmation; non-interactive
runs and stdin input require --yes. JSON returns the server result; text
shows counts and the commit after success.

```
n8n promotion project apply <project-id> [flags]
```

### Examples

```
n8n promotion project apply PROJECT_ID --workflow-id WORKFLOW_ID
n8n promotion project apply PROJECT_ID --input request.json --yes --output json
```

### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
--expected-branch string reviewed branch name (default: omitted; requires expected config ID and commit)
--expected-commit string reviewed lowercase full 40- or 64-digit hex commit SHA (default: omitted; requires expected config ID and branch)
--expected-config-id string reviewed config ID, 1 to 36 characters (default: omitted; requires expected branch and commit)
--expected-from string changes or blocked-apply JSON file, or - for stdin (default: explicit expected-source flags; stdin requires --yes)
-h, --help help for apply
--input string request JSON file path or - for stdin, maximum 1 MiB (default: use document flags; stdin requires --yes)
--output string output format: text or json (default: text; JSON is the full server result) (default "text")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
--workflow-id stringArray selected workflow ID, 1 to 36 characters; repeat for each ID (default: none; required unless --input is used)
--yes confirm content changes without prompting (default: prompt; required for non-interactive or stdin input)
```

### SEE ALSO

* [n8n promotion project](n8n_promotion_project.md) - Manage projects linked to a promotion connection

42 changes: 42 additions & 0 deletions docs/n8n_promotion_project_changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## n8n promotion project changes

List workflow changes for a project's promotion branch

### Synopsis

Compare a team project with its resolved promotion branch without changing content.
Start with 'n8n project list' for the project ID. The project's own connection
takes precedence over the instance connection; clone the chosen direction
first with 'n8n promotion checkout clone'. Apply requires gitConnection:pull;
promote requires gitConnection:push. Text lists workflow IDs, statuses, and
dependency counts; JSON includes changes, source, and nullable commitSha.
Review the IDs before project apply or promote. Save apply JSON for
--expected-from to reject a branch that moves after review.

```
n8n promotion project changes <project-id> <apply|promote> [flags]
```

### Examples

```
n8n promotion project changes PROJECT_ID apply --output json > changes.json
n8n promotion project changes PROJECT_ID promote --sort updatedAt --order desc
```

### Options

```
--context string saved context name to use (falls back to N8N_CONTEXT, then the saved current context; see 'n8n config context list')
-h, --help help for changes
--order string sort order: asc or desc (default: asc) (default "asc")
--output string output format: text or json (default: text; JSON includes the reviewed source) (default "text")
--search string workflow name search string (default: no filter)
--sort string sort field: name, updatedAt, or status (default: name) (default "name")
--url string instance URL override, e.g. https://n8n.example.com (falls back to N8N_URL, then the selected context URL)
```

### SEE ALSO

* [n8n promotion project](n8n_promotion_project.md) - Manage projects linked to a promotion connection

Loading
Loading