Skip to content

docs(cli): document --timeout option for sleakops build #197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucaiz merged 1 commit into from
May 28, 2026
+22 −0
Merged

docs(cli): document --timeout option for sleakops build #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions content/docs/en/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ As previously mentioned the key might be an input here or a environment variable

Also, you might mark if you want the process to **wait** the build to be finished or not.

When you use **wait**, you can also set a **timeout** (in minutes) to cap how long the CLI waits for the build to finish. It defaults to **180 minutes**; pass `0` to wait indefinitely. You can also set it through the `BUILD_TIMEOUT_MINUTES` environment variable.

| **Option** | **Description** |
| ------------- | --------------------------------------------------------------------------- |
| **--wait** | Wait for the build to finish before returning. |
| **--timeout** | Minutes to wait when using `--wait`. Default `180`. Use `0` for no timeout. |

:::tip
The timeout is client-side: it controls how long the CLI watches the build, not the build itself on the backend. When it expires, the CLI prints a message and exits with code `1`, so a stuck build fails your CI pipeline instead of silently passing.
:::

### 3. Make a Deploy

Once your build is ready, you can effortlessly deploy your application using the following command:
Expand Down
11 changes: 11 additions & 0 deletions content/docs/es/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@ sleakops build -p myproject -b main --docker-args "ARG1=value1,ARG2=value2"
Esto es particularmente útil para pipelines de CI/CD donde quieres pasar diferentes argumentos basados en el entorno o contexto de construcción.
:::

Cuando usas **wait**, también puedes definir un **timeout** (en minutos) para limitar cuánto espera la CLI a que termine la compilación. El valor por defecto es **180 minutos**; pasa `0` para esperar indefinidamente. También puedes configurarlo mediante la variable de entorno `BUILD_TIMEOUT_MINUTES`.

| **Opción** | **Descripción** |
| ------------- | ------------------------------------------------------------------------------------- |
| **--wait** | Espera a que la compilación termine antes de retornar. |
| **--timeout** | Minutos a esperar cuando se usa `--wait`. Por defecto `180`. Usa `0` para sin límite. |

:::tip
El timeout es del lado del cliente: controla cuánto observa la CLI a la compilación, no la compilación en sí en el backend. Cuando se agota, la CLI imprime un mensaje y sale con código `1`, de modo que una compilación colgada hace fallar tu pipeline de CI en vez de pasar silenciosamente.
:::

### 3. Realizar un Despliegue

Una vez que tu compilación esté lista, puedes desplegar tu aplicación fácilmente usando el siguiente comando:
Expand Down