Project

General

Profile

action #81890

Extend help for openQA client config, e.g. mention the environment variable OPENQA_CONFIG

Added by okurz 3 months ago.

Status:
Workable
Priority:
Low
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2021-01-08
Due date:
% Done:

0%

Estimated time:
Difficulty:

Description

Motivation

Many users use API key and secret command line parameters because they are not aware of the config file or the according format. Also bots are all using the same user, e.g. "geekotest", likely because people are not aware how OPENQA_CONFIG works, see https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/UserAgent.pm#L37 . We can improve the help.

Acceptance criteria

  • AC1: --help of openqa-client and openqa-cli make the information about the config file and OPENQA_CONFIG easily accessible

Suggestions

  • Extend the help
  • Consolidate the different comments and help strings we have
  • Ensure the env variable OPENQA_CONFIG is mentioned in help+doc

Also available in: Atom PDF