---
title: "overlane release promotion"
description: "Show or set how internal releases reach stable"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane release promotion

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

With no flags, prints the setting. --promote follow|automatic|manual: automatic promotes a release on its own once it has soaked with nothing blocking it, manual leaves it to `overlane release promote`, follow (the default) promotes on its own when the team's autonomy setting is autonomous. --soak-hours sets the soak (1 to 720, default 24). Changing it needs a role that manages policy.

## Usage

```sh
overlane release promotion [--promote SETTING] [--soak-hours HOURS] [--service URL] [--team TENANT_ID] [--dry-run]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--promote` | one of `follow`, `automatic`, `manual` | no |  | follow, automatic or manual |
| `--soak-hours` | string | no |  | Hours a release soaks before it promotes on its own, 1 to 720 |
| `--service` | string | no |  | The service address (default: OVERLANE_SERVICE_URL, then the project's binding, then the hosted service) |
| `--team` | string | no |  | The team (tenant) to act on (default: the one your token belongs to) |
| `--dry-run` | boolean | no |  | Print the requests and file changes this command would make, then stop. Needs no credentials. |

## Examples

```sh
overlane release promotion
overlane release promotion --promote manual
overlane release promotion --promote automatic --soak-hours 48
```

## Behavior

- Effect: `write` (changes local or hosted state).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: yes. Accepts `--force`: no.
- Machine-readable description: `overlane schema release promotion`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "settings": {
          "type": "object",
          "properties": {
            "promote": {
              "default": "follow",
              "type": "string",
              "enum": [
                "follow",
                "automatic",
                "manual"
              ]
            },
            "soakHours": {
              "default": 24,
              "type": "integer",
              "minimum": 1,
              "maximum": 720
            }
          },
          "required": [
            "promote",
            "soakHours"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "tenantId",
        "settings"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/release-promotion/index.mdx