Improve log output for audit mode #528
Description
A customer reported seeing this log output when using --audit mode:
INFO Audit mode enabled to keep return code 10 instead of setting to 0
This is confusing language, even though it is still correct behavior. That is, the exit codes documentation states:
Exit codes of 10 or higher represent situations not directly linked to Phylum analysis. These errors are important because they indicate a complete Phylum analysis was not possible, which necessitates further investigation. An option is available to explicitly prevent these errors from setting an exit code.
The option it is referring to is --ignore-errors, which should also be specified if you want a zero (0) exit code during a "pilot" phase where the CI build pipeline is not meant to break. This FAQ provides a bit more context about why there is a distinction between analysis and non-analysis failures.
This issue is to make the log output more friendly:
- Improve the wording
- Suggest hints as to why the return code was kept even though audit mode was specified
- Suggest the
--ignore-errorsoption - Maybe provide a link to the FAQ
- Other ideas?