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

feat: add version to CRD spec #1215

Merged
merged 8 commits into from
Dec 19, 2023

Conversation

susanshi
Copy link
Collaborator

@susanshi susanshi commented Dec 13, 2023

Description

This PR adds version property to the plugins CRD spec. Currently ratify doesn't not support loading different version of a plugin, however as we iterate on new version of external plugin, there is a need to ensure compatibility. If CR / config specifies version 2.0, and at runtime only v1 could be found, customer should be able to see the error in the log.

If version is not provided, it is set to a default version of 1.0.0. Since version property is optional, this change is backwards compatible.

What this PR does / why we need it:

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)
  • [X ] 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?

Pending test:

  • with existing CR (no version in spec) installed, installing new version of ratify was successful
  • Validated backward compatibility with CRs with no version, we currently default to 1.0.0
  • Validate error when CR version is not compatible with installed plugin , error is shown on verify. Ideally this error should occur on kubectl apply of CR.

image

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 13, 2023

Codecov Report

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

Comparison is base (6105b50) 55.13% compared to head (e5457a3) 55.15%.

Files Patch % Lines
config/config.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1215      +/-   ##
==========================================
+ Coverage   55.13%   55.15%   +0.02%     
==========================================
  Files         104      104              
  Lines        6894     6902       +8     
==========================================
+ Hits         3801     3807       +6     
- Misses       2758     2760       +2     
  Partials      335      335              

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

@susanshi susanshi marked this pull request as ready for review December 15, 2023 00:16
@susanshi
Copy link
Collaborator Author

@binbin-li , i ve added some comments , please review when convenient, thanks!

Copy link
Collaborator

@binbin-li binbin-li left a comment

Choose a reason for hiding this comment

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

lgtm

@susanshi susanshi merged commit 49f63e1 into ratify-project:main Dec 19, 2023
21 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