Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

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

Open
MVrachev opened this issue May 1, 2019 · 1 comment
Open
Labels
enhancement New feature or request good first issue Good for newcomers task-size-small
Milestone

Comments

@MVrachev
Copy link
Contributor

MVrachev commented May 1, 2019

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 MVrachev added the enhancement New feature or request label May 1, 2019
@joshuagl joshuagl added this to the Near Future milestone May 2, 2019
@MVrachev
Copy link
Contributor Author

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers task-size-small
Projects
None yet
Development

No branches or pull requests

2 participants