Skip to content

Commit 7e0f15f

Browse files
kayodegigzmfocko
andcommitted
Document osh_options
Co-authored-by: Matej Focko <mfocko@redhat.com> Signed-off-by: Matej Focko <mfocko@redhat.com>
1 parent 0391999 commit 7e0f15f

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/configuration/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -786,6 +786,36 @@ We will be happy for any feedback regarding it, [please contact us](https://gith
786786

787787
(*string*) An option to set arguments of `csmock` (the tool used inside [OpenScanHub](https://openscanhub.fedoraproject.org/)). For instance, you can specify arguments like `--cppcheck-add-flag=--enable=style` to check styling issues as seen in [this example run](https://openscanhub.fedoraproject.org/task/10066/) triggered from [this](https://github.com/avahi/avahi/pull/641) testing pull-request on Avahi.
788788

789+
#### osh_options
790+
791+
A set of additional options passed to `osh-cli` for additional customizations of the functionality.
792+
793+
##### analyzer
794+
795+
(*string*) List of analyzers to be passed to `osh-cli`. Use comma as a separator, e.g. `gcc,clang,cppcheck`.
796+
797+
```yaml
798+
osh_options:
799+
analyzer: "gcc, shellcheck"
800+
```
801+
802+
##### config
803+
804+
(*string*) Used to specify mock config name to be passed to `osh-cli`. If value is not set in the config, default value `"fedora-rawhide-x86_64"` is used.
805+
806+
```yaml
807+
osh_options:
808+
config: "fedora-rawhide-x86_64"
809+
```
810+
811+
##### profile
812+
813+
(*string*) Used to specify predefined scanning profile to be passed to `osh-cli`.
814+
815+
```yaml
816+
osh_options:
817+
profile: "dev"
818+
```
789819

790820
## Aliases
791821

0 commit comments

Comments
 (0)