Add documentation for max-parallelism option

This commit is contained in:
Riccardo Rigutini 2023-11-10 17:52:00 +00:00 committed by GitHub
parent da40211525
commit 6a4e6f58cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -28,6 +28,9 @@ It can be useful for automating repetitive tasks such as updating version number
- `exclude`: - `exclude`:
(Optional) The files to be excluded from the search. It can be the path to a file or a glob pattern matching one or more files (e.g. `**/*.md`). Defaults to an empty string. (Optional) The files to be excluded from the search. It can be the path to a file or a glob pattern matching one or more files (e.g. `**/*.md`). Defaults to an empty string.
- `max-parallelism`:
(Optional) The maximum number of files that will be processed in parallel. This can be used to control the performance impact of the operation on the system. It should be a positive integer. Defaults to `10`.
## Example usage ## Example usage
```yaml ```yaml
@ -41,6 +44,7 @@ It can be useful for automating repetitive tasks such as updating version number
replacement-text: 'world' replacement-text: 'world'
exclude: 'node_modules/**' exclude: 'node_modules/**'
encoding: 'utf8' encoding: 'utf8'
max-parallelism: 10
# Replace all the occurrences of '{0}' with '42' in the README.md file # Replace all the occurrences of '{0}' with '42' in the README.md file
- name: Replace single file - name: Replace single file