Qaskx Project conf

The qaskx-config.yaml file is stored by default in the .well-known directory of the project.

This configuration file is custom for your project. Many of the values required by the qaskx-cli are extracted from the devops.json file located in the .well-known directory.

A sample, short configuration file is shown below:

environment: production

app:
  name: A Command Line Tool
  version: 0.1.0

rediops:
  depend: ""

generator:
  vcs: ""
  gateway: "~/Projects.shared/qaskx.tooling/templates/gateway"
  gateway_default: "traefik"
  cicd: ""

run:
  lint_openapi:
    image:
    rules_file: .spectral.yaml
    skip_pull: true
    
file_format:
  left_quote: "'"
  right_quote: "'"
  separator: ","
  escape_match: "'"
  escape_value: "\\'"
  char_escape: true
  num_escape: false

logger:
  provider: ""
  log_level_base: ""
  log_level: 2
  log_writer: ""

scan:
  options:
    skipfile: ""
    regexfile: ""
  skipfiles: []
  regex: []

activities:
  engines:
  - osEnvironment: windows
    category: TEST
    name: pwsh-command
    command: pwsh.exe
    option: -Command
  - osEnvironment: linux
    category: TEST
    name: pwsh-command
    command: pwsh
    option: -Command
  - osEnvironment: windows
    category: BUILD
    name: pwsh-command
    command: pwsh.exe
    option: -Command
  - osEnvironment: windows
    category: BUILD
    name: pwsh-script
    command: pwsh.exe
    option: -File
  - osEnvironment: linux
    category: BUILD
    name: pwsh-command
    command: pwsh
    option: -Command
  - osEnvironment: linux
    category: BUILD
    name: pwsh-script
    command: pwsh
    option: -File
  - osEnvironment: windows
    category: INSTALL
    name: pwsh-command
    command: pwsh.exe
    option: -Command
  - osEnvironment: linux
    category: INSTALL
    name: pwsh-command
    command: pwsh
    option: -Command
  - osEnvironment: darwin
    category: INSTALL
    name: ""
    command: /bin/sh
    option: -c

The configuration file has a number of segments and you are unlikely to require all or many of these.

The most common setting you will change is the log_level. In normal operation a value of “2” should suffice, but if there is an error then you may care to change this value in increments to “6”. The logging level will only work if you have specified the “–verbose” option.

Alternatively you can use the command options “–vv” and “–vvv” to increase the log level for the execution and place the command execution into verbose mode.

Note: If you specify both –verbose and –silent then the silent option takes precedence.