go/task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2025-11-25 22:32:55 +02:00
Code Issues Releases Activity

docs: Update Remote Taskfiles default values

Browse Source 
* 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.
This commit is contained in:
merusso
2025-09-23 07:10:20 -05:00
committed by GitHub
parent 979ad523ef
commit 0f9baf62a1
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
executor.go
View File

@@ -240,7 +240,7 @@ func (o *timeoutOption) ApplyToExecutor(e *Executor) {
} }
// WithCacheExpiryDuration sets the duration after which the cache is considered // WithCacheExpiryDuration sets the duration after which the cache is considered
// expired. By default, the cache is considered expired after 24 hours. // expired. By default, the cache is 0 (disabled).
func WithCacheExpiryDuration(duration time.Duration) ExecutorOption { func WithCacheExpiryDuration(duration time.Duration) ExecutorOption {
return &cacheExpiryDurationOption{duration: duration} return &cacheExpiryDurationOption{duration: duration}
} }

4
website/src/docs/experiments/remote-taskfiles.md
View File

@@ -330,7 +330,7 @@ remote:
#### `timeout` #### `timeout`
- **Type**: `string` - **Type**: `string`
- **Default**: Not specified - **Default**: 10s
- **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$` - **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$`
- **Description**: Timeout duration for remote operations (e.g., '30s', '5m') - **Description**: Timeout duration for remote operations (e.g., '30s', '5m')
@@ -342,7 +342,7 @@ remote:
#### `cache-expiry` #### `cache-expiry`
- **Type**: `string` - **Type**: `string`
- **Default**: Not specified - **Default**: 0s (no cache)
- **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$` - **Pattern**: `^[0-9]+(ns|us|µs|ms|s|m|h)$`
- **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', '24h') - **Description**: Cache expiry duration for remote Taskfiles (e.g., '1h', '24h')