Project

General

Profile

action #98631

Ensure all environment variables supported by openQA are documented

Added by cdywan 11 months ago. Updated 11 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Feature requests
Target version:
Start date:
2021-09-01
Due date:
2021-09-22
% Done:

0%

Estimated time:
Difficulty:

Description

Motivation

In the context of #97856 I was indeed wondering where we "usually" document OPENQA_-prefixed env variables, and it seems like the answer is, "usually" nowhere at all 🤔️ osukup was asking about that as well.
A couple of queries show the discrepancy easily:

grep -hoP '.*`\KOPENQA_[A-Z]+' docs/*.asciidoc | sort -u
grep -RhoP '.*\KOPENQA_[A-Z]+' lib | sort -u

It would be great if we could fail tests/ CI/ PRs on undocumented environment variables. os-autoinst has 04-check_vars_docu.t for that, althugh that's kinda specialized and produces some kind of table output.

Acceptance criteria

  • AC1: CI fails if all environment variables aren't documented

Suggestions

  • Look at what os-autoinst currently implements
  • Consider a solution more tailored to openQA
  • Find an existing project/Perl module scanning for undocumented code

Related issues

Copied from openQA Project - action #97856: [sporadic] openqa-review pipeline failed: ConnectionResetError size:MResolved2021-09-012021-09-22

History

#1 Updated by cdywan 11 months ago

  • Copied from action #97856: [sporadic] openqa-review pipeline failed: ConnectionResetError size:M added

#2 Updated by okurz 11 months ago

  • Target version set to future

The check could be a simple git grep

Also available in: Atom PDF