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
14 changes: 13 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,18 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`n8n promotion connection list`](n8n_promotion_connection_list.md) | List promotion connections |
| [`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 environment connect`](n8n_promotion_environment_connect.md) | Prepare the local checkout of a promotion environment |
| [`n8n promotion environment create`](n8n_promotion_environment_create.md) | Create a promotion environment |
| [`n8n promotion environment delete`](n8n_promotion_environment_delete.md) | Permanently delete a promotion environment |
| [`n8n promotion environment disconnect`](n8n_promotion_environment_disconnect.md) | Remove the local checkout of a promotion environment |
| [`n8n promotion environment get`](n8n_promotion_environment_get.md) | Show one promotion environment |
| [`n8n promotion environment list`](n8n_promotion_environment_list.md) | List promotion environments |
| [`n8n promotion environment project add`](n8n_promotion_environment_project_add.md) | Link a project to a promotion environment |
| [`n8n promotion environment project list`](n8n_promotion_environment_project_list.md) | List projects linked to a promotion environment |
| [`n8n promotion environment project remove`](n8n_promotion_environment_project_remove.md) | Unlink a project from a promotion environment |
| [`n8n promotion environment project`](n8n_promotion_environment_project.md) | Manage projects linked to a promotion environment |
| [`n8n promotion environment update`](n8n_promotion_environment_update.md) | Update a promotion environment |
| [`n8n promotion environment`](n8n_promotion_environment.md) | Manage promotion environments (n8n 2.46 and later) |
| [`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 |
Expand All @@ -187,7 +199,7 @@ edit the command's Short, Long, Example or flag usage and run `make docs`.
| [`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 |
| [`n8n promotion`](n8n_promotion.md) | Manage promotion providers, environments, connections, and apply/promote sync |
| [`n8n role create`](n8n_role_create.md) | Create a custom role |
| [`n8n role delete`](n8n_role_delete.md) | Permanently delete a custom role |
| [`n8n role get`](n8n_role_get.md) | Get one role |
Expand Down
2 changes: 1 addition & 1 deletion docs/n8n.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ n8n [flags]
* [n8n otel](n8n_otel.md) - Manage OpenTelemetry tracing settings
* [n8n package](n8n_package.md) - Export and import n8n packages (beta)
* [n8n project](n8n_project.md) - Manage projects and their members
* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync
* [n8n promotion](n8n_promotion.md) - Manage promotion providers, environments, connections, and apply/promote sync
* [n8n role](n8n_role.md) - Manage global and project roles
* [n8n role-mapping](n8n_role-mapping.md) - Manage identity-provider role-mapping rules
* [n8n saml](n8n_saml.md) - Manage licensed SAML SSO settings
Expand Down
38 changes: 25 additions & 13 deletions docs/n8n_promotion.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
## n8n promotion

Manage promotion providers, connections, and apply/promote sync
Manage promotion providers, environments, connections, and apply/promote sync

### Synopsis

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. For selected workflows, start with
project changes, then project apply or project promote. Use apply-continue

n8n 2.46 and later: start with 'provider list' to find a provider,
then 'environment list' to find an environment. An environment is one
remote for one direction: create one per direction on a provider with
'environment create', prepare its checkout with 'environment connect',
and link team projects to a projects-scope environment under
'environment project'. 'promote', 'apply', and the project selection
commands still address connections.

Older instances serve connections instead: 'connection list' finds 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. 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
package and imports with overwrite behavior, creating, updating, or
removing content to match, or reports why it is blocked and writes
nothing. Both mutate versioned
content and ask for confirmation. Config and connection removal can
remove local checkouts. This is the upstream Promotions generation: an
instance that serves GitConnections instead answers 404 or 503, which
reads as the availability diagnostic.
nothing. Both mutate versioned content and ask for confirmation.
Config, connection, and environment removal can remove local
checkouts. This is the upstream Promotions generation: an instance
that serves GitConnections instead answers 404 or 503, which reads as
the availability diagnostic.

```
n8n promotion [flags]
Expand All @@ -32,6 +41,8 @@ n8n promotion [flags]

```
n8n promotion provider list
n8n promotion environment list
n8n promotion environment connect ENVIRONMENT_ID
n8n promotion connection list
n8n promotion provider create --input provider.json
n8n promotion connection create --input connection.json
Expand All @@ -56,6 +67,7 @@ n8n promotion [flags]
* [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
* [n8n promotion environment](n8n_promotion_environment.md) - Manage promotion environments (n8n 2.46 and later)
* [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](n8n_promotion_provider.md) - Manage promotion providers
Expand Down
2 changes: 1 addition & 1 deletion docs/n8n_promotion_apply-continue.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ n8n promotion apply-continue <connection-id> [flags]

### SEE ALSO

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

2 changes: 1 addition & 1 deletion docs/n8n_promotion_apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ n8n promotion apply <connection-id> [flags]

### SEE ALSO

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

2 changes: 1 addition & 1 deletion docs/n8n_promotion_checkout.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ n8n promotion checkout [flags]

### SEE ALSO

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync
* [n8n promotion](n8n_promotion.md) - Manage promotion providers, environments, connections, and apply/promote sync
* [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

2 changes: 1 addition & 1 deletion docs/n8n_promotion_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ n8n promotion config [flags]

### SEE ALSO

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync
* [n8n promotion](n8n_promotion.md) - Manage promotion providers, environments, connections, and apply/promote sync
* [n8n promotion config apply](n8n_promotion_config_apply.md) - Manage the apply direction config
* [n8n promotion config delete](n8n_promotion_config_delete.md) - Delete one direction config
* [n8n promotion config promote](n8n_promotion_config_promote.md) - Manage the promote direction config
Expand Down
5 changes: 3 additions & 2 deletions docs/n8n_promotion_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ Manage promotion connections
### Synopsis

Manage promotion connections: one remote plus its two direction
configs. Start with 'list' to find the connection ID, then 'get' to
configs. n8n 2.46 and later replaced connections with environments:
use 'n8n promotion environment' there. Start with 'list' to find the connection ID, then 'get' to
read it, 'create' to add one on a provider, or 'update' to change its
name, target, or provider.

Expand Down Expand Up @@ -33,7 +34,7 @@ n8n promotion connection [flags]

### SEE ALSO

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, connections, and apply/promote sync
* [n8n promotion](n8n_promotion.md) - Manage promotion providers, environments, connections, and apply/promote sync
* [n8n promotion connection create](n8n_promotion_connection_create.md) - Create a promotion connection
* [n8n promotion connection delete](n8n_promotion_connection_delete.md) - Permanently delete a promotion connection
* [n8n promotion connection get](n8n_promotion_connection_get.md) - Show one promotion connection
Expand Down
53 changes: 53 additions & 0 deletions docs/n8n_promotion_environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## n8n promotion environment

Manage promotion environments (n8n 2.46 and later)

### Synopsis

Manage promotion environments: one remote, one direction (apply or
promote), its settings, and its local checkout. n8n 2.46 replaced
connections with environments; on older instances use 'n8n promotion
connection' instead.

Start with 'list' to find the environment ID, then 'get' to read it,
'create' to add one on a provider, or 'update' to change its name,
provider, remote, or settings. 'connect' prepares the local checkout
and 'disconnect' removes it. Link team projects to a projects-scope
environment under 'project'. The instance can have one environment for
each direction.

Deleting an environment removes its project links and local checkout;
its provider is kept and nothing in Git changes.

```
n8n promotion environment [flags]
```

### Examples

```
n8n promotion environment list
n8n promotion environment get ENVIRONMENT_ID
n8n promotion environment create --input environment.json
n8n promotion environment connect ENVIRONMENT_ID
n8n promotion environment project add ENVIRONMENT_ID PROJECT_ID
```

### Options

```
-h, --help help for environment
```

### SEE ALSO

* [n8n promotion](n8n_promotion.md) - Manage promotion providers, environments, connections, and apply/promote sync
* [n8n promotion environment connect](n8n_promotion_environment_connect.md) - Prepare the local checkout of a promotion environment
* [n8n promotion environment create](n8n_promotion_environment_create.md) - Create a promotion environment
* [n8n promotion environment delete](n8n_promotion_environment_delete.md) - Permanently delete a promotion environment
* [n8n promotion environment disconnect](n8n_promotion_environment_disconnect.md) - Remove the local checkout of a promotion environment
* [n8n promotion environment get](n8n_promotion_environment_get.md) - Show one promotion environment
* [n8n promotion environment list](n8n_promotion_environment_list.md) - List promotion environments
* [n8n promotion environment project](n8n_promotion_environment_project.md) - Manage projects linked to a promotion environment
* [n8n promotion environment update](n8n_promotion_environment_update.md) - Update a promotion environment

40 changes: 40 additions & 0 deletions docs/n8n_promotion_environment_connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## n8n promotion environment connect

Prepare the local checkout of a promotion environment

### Synopsis

Prepare one promotion environment on the instance that handles the
request; for a Git provider this clones the configured branch into
local storage. Connecting one environment does not make another
ready.

Connecting is safe to repeat and changes no project content by itself,
so it needs no confirmation. Connect again after 'get' reports a
checkout that does not match the environment. Requires
gitConnection:clone.

```
n8n promotion environment connect <environment-id> [flags]
```

### Examples

```
n8n promotion environment connect ENVIRONMENT_ID
n8n promotion environment connect ENVIRONMENT_ID --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')
-h, --help help for connect
--output string output format: text or json (JSON is the checkout returned by the API) (default "text")
--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 environment](n8n_promotion_environment.md) - Manage promotion environments (n8n 2.46 and later)

49 changes: 49 additions & 0 deletions docs/n8n_promotion_environment_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## n8n promotion environment create

Create a promotion environment

### Synopsis

Create one promotion environment from strict JSON supplied by --input.
Required fields are name (at most 128 characters), scope (instance or
projects), providerId, remote {"schemaVersion":1,"remoteUrl":"..."},
direction (apply or promote), and settings matching the direction:
apply {"schemaVersion":1,"branchName":"main"} or promote
{"schemaVersion":1,"baseBranchName":"main",
"createBranchOnPromotion":false}. The instance can have one
environment for each direction.

On a gitlab provider the remote URL must belong to the provider: the
environment stores only the repository path and derives remoteUrl from
the provider base URL. Read-only fields from 'environment get --output
json' (id, provider, checkout, createdAt, updatedAt,
remote.repositoryPath) are dropped with a note on stderr; other unknown
fields and trailing JSON documents are refused before transport.
Requires gitConnection:create. Follow with 'n8n promotion environment
connect ENVIRONMENT_ID'.

```
n8n promotion environment create [flags]
```

### Examples

```
n8n promotion environment create --input environment.json
printf '%s\n' '{"name":"prod","scope":"instance","providerId":"PROVIDER_ID","remote":{"schemaVersion":1,"remoteUrl":"git@example.com:org/repo.git"},"direction":"apply","settings":{"schemaVersion":1,"branchName":"main"}}' | n8n promotion environment create --input -
```

### 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 create
--input string promotion environment JSON file path, or - for stdin (required; maximum 1 MiB)
--output string output format: text or json (JSON is the environment returned by the API) (default "text")
--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 environment](n8n_promotion_environment.md) - Manage promotion environments (n8n 2.46 and later)

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

Permanently delete a promotion environment

### Synopsis

Permanently delete one promotion environment with its project links and
local checkout. Its provider is kept and nothing in Git changes, but
linked projects fall back to the instance environment, and promote or
apply for that direction stops working until an environment is
created and connected again. This cannot be undone.

To keep the environment and drop only the checkout, use 'n8n promotion
environment disconnect' instead. Interactive runs ask for
confirmation; non-interactive runs require --yes. Requires
gitConnection:delete.

```
n8n promotion environment delete <environment-id> [flags]
```

### Examples

```
n8n promotion environment delete ENVIRONMENT_ID
n8n promotion environment delete ENVIRONMENT_ID --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')
-h, --help help for delete
--output string output format: text or json (JSON is the deletion acknowledgement) (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 permanent environment, project link, and checkout deletion without prompting (required when stdin is not interactive)
```

### SEE ALSO

* [n8n promotion environment](n8n_promotion_environment.md) - Manage promotion environments (n8n 2.46 and later)

39 changes: 39 additions & 0 deletions docs/n8n_promotion_environment_disconnect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## n8n promotion environment disconnect

Remove the local checkout of a promotion environment

### Synopsis

Remove the local checkout of one promotion environment. The
environment, its credentials, its trusted SSH host keys, and its
project links are kept, but promote and apply through it stop working
until 'connect' runs again.

Interactive runs ask for confirmation; non-interactive runs require
--yes. Requires gitConnection:clone.

```
n8n promotion environment disconnect <environment-id> [flags]
```

### Examples

```
n8n promotion environment disconnect ENVIRONMENT_ID
n8n promotion environment disconnect ENVIRONMENT_ID --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')
-h, --help help for disconnect
--output string output format: text or json (JSON is the checkout returned by the API) (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 checkout removal without prompting (required when stdin is not interactive)
```

### SEE ALSO

* [n8n promotion environment](n8n_promotion_environment.md) - Manage promotion environments (n8n 2.46 and later)

Loading
Loading