Skip to content

Commit 0f9baf6

Browse files
authored
docs: Update Remote Taskfiles default values (#2430)
* docs: Update Remote Taskfiles default values This change updates the documentation for [Remote Taskfiles > Configuration](https://taskfile.dev/docs/experiments/remote-taskfiles#configuration) for `timeout` and `cache-expiry` to match the defaults in code. * docs: Update `cache-expiry` default to 0s * docs: Update executor.go comment Fix doc comment to indicate that cache expiry default duration is 0.
1 parent 979ad52 commit 0f9baf6

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

executor.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ func (o *timeoutOption) ApplyToExecutor(e *Executor) {
240240
}
241241

242242
// WithCacheExpiryDuration sets the duration after which the cache is considered
243-
// expired. By default, the cache is considered expired after 24 hours.
243+
// expired. By default, the cache is 0 (disabled).
244244
func WithCacheExpiryDuration(duration time.Duration) ExecutorOption {
245245
return &cacheExpiryDurationOption{duration: duration}
246246
}

website/src/docs/experiments/remote-taskfiles.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ remote:
330330
#### `timeout`
331331

332332
- **Type**: `string`
333-
- **Default**: Not specified
333+
- **Default**: 10s
334334
- **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$`
335335
- **Description**: Timeout duration for remote operations (e.g., '30s', '5m')
336336

@@ -342,7 +342,7 @@ remote:
342342
#### `cache-expiry`
343343

344344
- **Type**: `string`
345-
- **Default**: Not specified
345+
- **Default**: 0s (no cache)
346346
- **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$`
347347
- **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', '24h')
348348

0 commit comments

Comments
 (0)