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: update ReferrerNotFound error to be more accurate #1408

Merged
merged 2 commits into from
Apr 19, 2024

Conversation

binbin-li
Copy link
Collaborator

Description

What this PR does / why we need it:

  1. Modify ErrorCodeReferrersNotFound to ErrorCodeEmptyVerifierReport as it aligns better with the actual issue.
  2. Revise the description of the error to list potential underlying causes.
  3. Add WithDescription to custom error for improved printout capability.

image

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

Fixing one error in: #1321

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 binbin-li force-pushed the fix-referrer-error branch from 89586cb to 037f0d1 Compare April 18, 2024 14:39
@binbin-li binbin-li changed the title [WIP] fix: update ReferrerNotFound error to be more accurate fix: update ReferrerNotFound error to be more accurate Apr 18, 2024
akashsinghal
akashsinghal previously approved these changes Apr 18, 2024
Copy link
Collaborator

@akashsinghal akashsinghal left a comment

Choose a reason for hiding this comment

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

Thanks for updating this! Just a reminder that we'll need to update the docs too :)

@binbin-li
Copy link
Collaborator Author

@yizha1 do you think if the new description makes sense to customers? Any suggestions for improvement?

@binbin-li
Copy link
Collaborator Author

synced with Yi offline, rename the error code to ErrorCodeNoVerifierReport

Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (dev@56be5bb). Click here to learn what that means.

Additional details and impacted files
@@          Coverage Diff           @@
##             dev    #1408   +/-   ##
======================================
  Coverage       ?   65.58%           
======================================
  Files          ?      109           
  Lines          ?     5579           
  Branches       ?        0           
======================================
  Hits           ?     3659           
  Misses         ?     1565           
  Partials       ?      355           

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

susanshi
susanshi previously approved these changes Apr 19, 2024
@binbin-li binbin-li enabled auto-merge (squash) April 19, 2024 15:43
@binbin-li binbin-li merged commit f063058 into ratify-project:dev Apr 19, 2024
17 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.

3 participants