Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add vulnerability report verifier design doc #1208

Merged

Conversation

akashsinghal
Copy link
Collaborator

Description

What this PR does / why we need it:

  • adds vulnerability report design doc

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Copy link

codecov bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (81291d6) 55.13% compared to head (d295e1d) 55.13%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1208   +/-   ##
=======================================
  Coverage   55.13%   55.13%           
=======================================
  Files         104      104           
  Lines        6879     6879           
=======================================
  Hits         3793     3793           
  Misses       2753     2753           
  Partials      333      333           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@akashsinghal
Copy link
Collaborator Author

This is a copy of the original doc that was shared on hackmd

@junczhu
Copy link
Collaborator

junczhu commented Dec 11, 2023

Thanks for this good example, and I would update this doc change as well

@akashsinghal akashsinghal enabled auto-merge (squash) December 12, 2023 00:33
@akashsinghal akashsinghal merged commit e7a20b5 into ratify-project:main Dec 12, 2023
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants