ratify icon indicating copy to clipboard operation
ratify copied to clipboard

feat: Add more fields to verification response

Open binbin-li opened this issue 6 months ago • 1 comments

Description

What this PR does / why we need it:

This PR is part of effort for addressing https://github.com/ratify-project/ratify/issues/1654

  1. Add VerifierType and VerifierName to replace type and name.
  2. Add ErrorReason field to indicate root cause of an error.
  3. Add Remediation field to include trouble shooting guide for the error.
  4. Fixed a bug that missing Subject value in verifier report when using config policy.
  5. Add ReferenceDigest to the verifierReport in V0 which is used by config poliy.

This PR does not change the usage of verification response, so the verifier report should look the same as before. We'll have separate PRs to update report generation logic to carry above values.

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 https://github.com/ratify-project/ratify/issues/1654

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

binbin-li avatar Jul 29 '24 14:07 binbin-li