Skip to content

Commit e6b656c

Browse files
Document --timeout CLI flag in README (#29)
Add the --timeout option to the CLI Options table and a troubleshooting entry for timeout errors. Generated with [Linear](https://linear.app/linear/issue/LIN-64456/update-linear-release-docs-to-mention-the-timeout-flag#agent-session-d05bc251) Co-authored-by: Axel Niklasson Yun <6113675+axelniklasson@users.noreply.github.com> Co-authored-by: linear[bot] <44709815+linear[bot]@users.noreply.github.com>
1 parent 312f5d1 commit e6b656c

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ linear-release update --stage="in review" --release-version="1.2.0"
153153
| `--json` | `sync`, `complete`, `update` | Output result as JSON |
154154
| `--quiet` | `sync`, `complete`, `update` | Only print errors |
155155
| `--verbose` | `sync`, `complete`, `update` | Print detailed progress including debug diagnostics |
156+
| `--timeout` | `sync`, `complete`, `update` | Max duration in seconds before aborting (default: 60) |
156157

157158
### Command Targeting
158159

@@ -217,6 +218,7 @@ Path patterns can also be configured in your pipeline settings in Linear. If bot
217218
- **No release created by `sync`**: if no commits match the computed range (or path filters), `sync` returns `{"release":null}`.
218219
- **Stage update fails**: verify stage name exactly. If stage names normalize to the same value, use the exact stage name to avoid ambiguity.
219220
- **`--name` seems ignored**: `--name` only applies to `sync`; `complete` and `update` ignore it and print a warning.
221+
- **Operation timed out**: the CLI aborts after 60 seconds by default. For large repositories or slow networks, increase the limit with `--timeout=120`.
220222

221223
## License
222224

0 commit comments

Comments
 (0)