Ensure all environment variables supported by openQA are documented
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.
- AC1: CI fails if all environment variables aren't documented
- Look at what os-autoinst currently implements
- Consider a solution more tailored to openQA
- Find an existing project/Perl module scanning for undocumented code