Skip to content

Commit

Permalink
feat(docs): Add Docs about skip_security_updates_on_concurrent_limit
Browse files Browse the repository at this point in the history
  • Loading branch information
truls1502 committed Jun 28, 2024
1 parent 7b00a6b commit eafcccf
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
1 change: 1 addition & 0 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ disableKinds = ["taxonomyTerm"]
"labels": [],
"labels_security": [],
"number_of_concurrent_updates": 0,
"skip_security_updates_on_concurrent_limit": 1,
"one_pull_request_per_package": 0,
"run_scripts": 1,
"security_updates_only": 0,
Expand Down
52 changes: 52 additions & 0 deletions content/skip_security_updates_on_concurrent_limit.md
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.

0 comments on commit eafcccf

Please sign in to comment.