search

securesauce / precaution-beta

Precaution provides a simple, automated code review for GitHub projects by running code linters with a security focus on pull requests.
Other
1 stars 0 forks source link

Make the output of Precaution to display the configuration options #215

Open MVrachev opened 5 years ago

MVrachev commented 5 years ago

Is your feature request related to a problem? Please describe. Imagine you install Precaution on your project on an early stage. Then you set up your precaution configuration file. After a while, a new pull request comes. You see that Precaution missed some serious mistakes and you are frustrated. Then you remembered that months ago you had setup Precaution configuration file.

Describe the solution you'd like I think it will be cool if we give information about the user configuration options stetted up by the user in his precaution config file.

I imagine we can use something like this table from the initial setup doc: image

but we will have on first column "option" and then on the second common "values".

MVrachev commented 5 years ago

We have already implemented custom configuration support. The config file our users can use is .precaution.yaml.

So, I imagine that this issue will require to read all configuration values from the .precaution.yaml file (if they are using this config file) and then add it to the text field of the GitHub check_run.output.text field: https://developer.github.com/v3/checks/runs/#update-a-check-run