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

Add report functionality for detect-secrets + tests #235

Closed MVrachev closed 5 years ago

MVrachev commented 5 years ago

This is the reporting functionality for detect_secrets which will process the results from the detect_secrets detect_secrets scan and it will create valid GitHub annotation objects for the issues.

All upcoming pull requests to integrate detect_secrets into Precaution can be found here: https://github.com/vmware/precaution/issues/209#issuecomment-492964642

Related to: https://github.com/vmware/precaution/issues/209

Signed-off-by: Martin Vrachev mvrachev@vmware.com

MVrachev commented 5 years ago

So this PR covers only partial functionality. So what other PRs are you planning to submit? It would be good to get in the practice of documenting your planned PRs in the Issue.

I am doing that already: https://github.com/vmware/precaution/issues/160 I was just not sure where to put my planned pull requests. I mean should I put them in the existing issue tracker as a comment: https://github.com/vmware/precaution/issues/209 or should I create another issue where it will be more visible the progress?

You PR message added design questions, but the PR is not really a good place for that.

Yes, you are right. I just thought about those design questions just before I submitted the pr and I didn't realize that they are better to be placed in the issue tracker. I will fix that.

MVrachev commented 5 years ago

I moved the design discussion in our issue tracker: https://github.com/vmware/precaution/issues/209#issuecomment-492957066 and I gave planning how many pull requests we need to fully integrate detect-secrets here: https://github.com/vmware/precaution/issues/209#issuecomment-492964642

MVrachev commented 5 years ago

As I explained here https://github.com/vmware/precaution/issues/209#issuecomment-501589208 we decided that we won't use detect-secret. That's why I will close this pr.