-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): Add Docs about skip_security_updates_on_concurrent_limit
- Loading branch information
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
title: "Skip_security_updates_on_concurrent_limit" | ||
date: 2024-06-28T13:10:02+02:00 | ||
anchor: "skip_security_updates_on_concurrent_limit" | ||
weight: | ||
--- | ||
|
||
|
||
## Configuration | ||
|
||
__name__: skip_security_updates_on_concurrent_limit | ||
__type__: int | ||
__default__: 1 | ||
|
||
{{< highlight JSON "hl_lines=5" >}} | ||
{ | ||
"name": "company/project", | ||
"extra": { | ||
"violinist": { | ||
"skip_security_updates_on_concurrent_limit": 1 | ||
} | ||
} | ||
} | ||
{{< /highlight >}} | ||
|
||
Indicate if you want to skip security updates when the concurrent limit is reached. | ||
|
||
## Explanation | ||
|
||
This option ensures the security package updates will NOT bypass the concurrent limit. | ||
|
||
## Example | ||
By default, if you have used `number_of_concurrent_updates` to limit the number of concurrent, the Violinist will still bypass any security package updates even when the concurrent limit has been reached. In case you have, for example, limited CI minutes or any other reason still to keep strict control over the number of concurrent updates, you can do the following to ensure that the security updates will not bypass: | ||
|
||
|
||
{{< highlight JSON "hl_lines=9" >}} | ||
{ | ||
"name": "company/project", | ||
"description": "My awesome project", | ||
"require": { | ||
"vendor/package": "~1.0.0", | ||
}, | ||
"extra": { | ||
"violinist": { | ||
"number_of_concurrent_updates": 5, | ||
"skip_security_updates_on_concurrent_limit": 0 | ||
} | ||
} | ||
} | ||
{{< /highlight >}} | ||
|
||
This way, the security packages will not be bypassed when the concurrent limit is reached. However, when the concurrent limit is reached, you have to manually check and perform the security updates. |