tartufo icon indicating copy to clipboard operation
tartufo copied to clipboard

tartufo results should mention the tartufo version used at least, if not even the full path used to see options

Open pmevzek-godaddy opened this issue 3 years ago • 0 comments

Feature Request

Is your feature request related to a problem? Please describe.

Tartufo output, at least in JSON mode, includes "excluded_paths" and "excluded_signatures" information.

It should however also include tartufo version used, as the list of checks done and those by default, can vary from one version to another. Maybe the other flag used when starting tartufo should be recorded in the output too, specifically the flags that allow/deny specific checks.

Without this information, it is difficult to compare output results in time and/or from different versions.

Describe the solution you'd like

Add JSON attributes to give more data like one for the full command path used to run tartufo and one for the tartufo version used.

It may be useful, if adding this feature, to also start versioning the JSON output, that is giving an arbitrary number for the JSON output, so that if later the structure (schema) of JSON output changes, the consumer of it could adapt based on a version number included in it. Or if the tartufo command version number is included maybe that is enough and no specific JSON output version number is needed.

Describe alternatives you've considered

N/A

Teachability, Documentation, Adoption, Migration Strategy

Nothing for users to do, the information will be in output automatically. Those not interested by it won't be impacted by it.

pmevzek-godaddy avatar Mar 12 '21 21:03 pmevzek-godaddy