Skip to content

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

Merged
lucaiz merged 1 commit into
developfrom
docs/cli-build-timeout
May 28, 2026
Merged

docs(cli): document --timeout option for sleakops build#197
lucaiz merged 1 commit into
developfrom
docs/cli-build-timeout

Conversation

@lautaro-suarez
Copy link
Copy Markdown
Contributor

@lautaro-suarez lautaro-suarez commented May 27, 2026

Summary

Documents the new --timeout flag on sleakops build, added in CLI PR sleakops/cli#22. Added to the "Create a Build" section in both EN and ES.

Covers:

  • --timeout <min>: minutes the CLI waits when using --wait. Default 180, 0 disables the timeout (polls indefinitely).
  • BUILD_TIMEOUT_MINUTES env var as an alternative.
  • The timeout is client-side (how long the CLI watches, not the backend build), and on expiry the CLI exits 1 so a stuck build fails CI instead of silently passing.

Notes

  • Opened as draft — to merge once CLI feat: added environment page #22 ships the flag.
  • ES file kept its existing --docker-args tip; the timeout block was added below it.

🤖 Generated with Claude Code

Summary by CodeRabbit

Notas de lanzamiento

  • Documentación
    • Se amplió la documentación del comando sleakops build con detalles sobre las opciones --wait y --timeout, incluyendo configuración del timeout en minutos (por defecto 180), comportamiento con valor 0 para espera indefinida y configuración mediante variable de entorno BUILD_TIMEOUT_MINUTES.

Review Change Stack

Documents the new --timeout flag added in cli PR #22: minutes the CLI
waits with --wait (default 180, 0 disables), BUILD_TIMEOUT_MINUTES env
var, and the client-side / exit-code-1 behavior. EN + ES.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 27, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f18a835d-8ff5-4ce6-b7f6-dd6a4fd85ac7

📥 Commits

Reviewing files that changed from the base of the PR and between 0bd1356 and 30511f1.

📒 Files selected for processing (2)
  • content/docs/en/cli.mdx
  • content/docs/es/cli.mdx

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.


Walkthrough

Se documenta el comportamiento del timeout en el comando sleakops build: cuando se usa --wait, puede limitarse el tiempo de espera con --timeout (en minutos, defecto 180 minutos; 0 = indefinido), configurarble también vía variable de entorno BUILD_TIMEOUT_MINUTES, con aclaración sobre el control client-side y código de salida.

Changes

Documentación CLI: opciones --wait y --timeout

Layer / File(s) Resumen
Documentación de opciones --wait y --timeout
content/docs/en/cli.mdx, content/docs/es/cli.mdx
Se añade en inglés y español descripción del timeout configurable (minutos, defecto 180, 0 para sin límite), alternativa vía BUILD_TIMEOUT_MINUTES, tabla de opciones, y nota aclaratoria sobre control client-side con código de salida 1.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutos

Poem

En piñas y CLI, la paz encontramos,
Con timeout infinito, jamás nos apuramos,
180 minutos, o cero si esperar queremos,
Documentación clara, conflictos resolvemos. 🍍⚡

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cli-build-timeout

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@lucaiz lucaiz marked this pull request as ready for review May 28, 2026 13:21
@lucaiz lucaiz merged commit 6f091ad into develop May 28, 2026
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants