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 doc for subscribed events and events workflows #241

Closed MVrachev closed 4 years ago

MVrachev commented 5 years ago

It will be really useful if we add documentation for the different events we are subscribed to answering the questions "why we are subscribed to them" and "when" they are triggered.

Closes: https://github.com/vmware/precaution/issues/211

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

codecov-io commented 5 years ago

Codecov Report

Merging #241 into master will not change coverage. The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #241   +/-   ##
======================================
  Coverage    98.3%   98.3%           
======================================
  Files          18      18           
  Lines         355     355           
  Branches       38      38           
======================================
  Hits          349     349           
  Misses          6       6

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 925bfde...36c5c48. Read the comment docs.

MVrachev commented 5 years ago

I updated my pr with the suggestions given by @joshuagl https://github.com/vmware/precaution/pull/241#pullrequestreview-270232476

I changed every event with the template you suggested and I made them bold. What do you think @joshuagl?

MVrachev commented 4 years ago

I updated my pr. Because all triggers are actually different entry point to a new Precaution scan I changed them to be the same and I removed one redundant line.

MVrachev commented 4 years ago

Same comments as before.

Sorry, I made the changes but I was distracted by something else and I didn't push them.