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

fix: rename error for verifier plugins to be more generic #1129

Conversation

akashsinghal
Copy link
Collaborator

@akashsinghal akashsinghal commented Oct 16, 2023

Description

What this PR does / why we need it:

Currently, external verifier plugin failures are wrapped in a single error code that's specific to signature failures. this is confusing for non signature artifacts such as vuln scans and SBOMs. This PR makes the error code more generic. The error code contains the plugin name which provides enough information to determine if it's a signature or not.

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):

Corresponding doc change here: ratify-project/ratify-web#20

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

@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (f5eaa99) 52.30% compared to head (b8cec9b) 52.30%.
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1129   +/-   ##
=======================================
  Coverage   52.30%   52.30%           
=======================================
  Files         101      101           
  Lines        6305     6305           
=======================================
  Hits         3298     3298           
  Misses       2688     2688           
  Partials      319      319           
Files Coverage Δ
pkg/verifier/notation/notation.go 86.04% <100.00%> (ø)
pkg/verifier/plugin/plugin.go 70.83% <0.00%> (ø)

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

Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. thanks!

@akashsinghal akashsinghal enabled auto-merge (squash) October 19, 2023 17:09
@akashsinghal akashsinghal merged commit e18f99c into ratify-project:main Oct 19, 2023
19 of 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.

2 participants