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

📖 chore: doc comment the need to keep using blang for version ranges #1600

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

azych
Copy link
Contributor

@azych azych commented Jan 13, 2025

Adds doc comment about the need to keep using github.com/blang/semver library for handling version ranges.
Follow up from #1565

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@azych azych requested a review from a team as a code owner January 13, 2025 08:43
Copy link

netlify bot commented Jan 13, 2025

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit e562d1f
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/6788c389ac39ef000887dd12
😎 Deploy Preview https://deploy-preview-1600--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.75%. Comparing base (1bbc6cb) to head (e562d1f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1600      +/-   ##
==========================================
+ Coverage   66.69%   66.75%   +0.05%     
==========================================
  Files          57       57              
  Lines        4588     4593       +5     
==========================================
+ Hits         3060     3066       +6     
+ Misses       1303     1302       -1     
  Partials      225      225              
Flag Coverage Δ
e2e 52.67% <0.00%> (-0.08%) ⬇️
unit 53.71% <100.00%> (+0.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

perdasilva
perdasilva previously approved these changes Jan 14, 2025
Copy link
Contributor

@perdasilva perdasilva left a comment

Choose a reason for hiding this comment

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

<3 thank you!

@perdasilva perdasilva added this pull request to the merge queue Jan 14, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 14, 2025
@perdasilva perdasilva added this pull request to the merge queue Jan 14, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 14, 2025
@LalatenduMohanty LalatenduMohanty added this pull request to the merge queue Jan 14, 2025
@camilamacedo86
Copy link
Contributor

camilamacedo86 commented Jan 14, 2025

/hold

Hi @azych and @perdasilva

Sorry, I remove this one from the Queue.

Just a small note before we proceed:

We won't be able to fully support the registry+v1 bundles due to fundamental differences in concepts and design choices. We've outlined the primary limitations in detail here: OLMv1 Limitations.

So we cannot add Because OLM v1 fully supports registry+v1 bundles (it is not true and we never will be to support all features of OLM V0, with registry+v1 bundles). Can you please refine this one?

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 14, 2025
@camilamacedo86 camilamacedo86 removed this pull request from the merge queue due to a manual request Jan 14, 2025
@azych
Copy link
Contributor Author

azych commented Jan 14, 2025

/hold

Hi @azych and @perdasilva

Sorry, I remove this one from the Queue.

Just a small note before we proceed:

We won't be able to fully support the registry+v1 bundles due to fundamental differences in concepts and design choices. We've outlined the primary limitations in detail here: OLMv1 Limitations.

So we cannot add Because OLM v1 fully supports registry+v1 bundles (it is not true and we never will be to support all features of OLM V0, with registry+v1 bundles). Can you please refine this one?

Would Because OLM v1 supports registry+v1 bundles be alright?

@azych
Copy link
Contributor Author

azych commented Jan 15, 2025

@camilamacedo86 @perdasilva

PR should be good to go, can you remove the hold and merge it?

Copy link
Contributor

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

Hi @azych

I would prefer if we added support for a "superset of" as suggested by @perdasilva, since it seems more accurate and aligns with the terminology we use in the documentation and other places.

That said, since we're no longer claiming full support for OLM v1 here, I’m okay with the current approach.

Just to share, the registry-v1 for OLM v1 is, in some way, deprecated. Until we are able to move with the Roadmap, it will remain, but we’re still moving forward in directions like adopting HelmChart. There’s a possibility of designing a registry-v2 in the future. This new design would aim to address the issues identified with registry-v1 and be more suited for OLM v1.

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 15, 2025
@camilamacedo86 camilamacedo86 added this pull request to the merge queue Jan 15, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 15, 2025
@azych
Copy link
Contributor Author

azych commented Jan 15, 2025

@camilamacedo86 it looks like there is still a hold in place for this, shouldn't it be removed?

I would prefer if we added support for a "superset of" as suggested by @perdasilva, since it seems more accurate and aligns with the terminology we use in the documentation and other places.

That said, since we're no longer claiming full support for OLM v1 here, I’m okay with the current approach.

Just to clarify - @perdasilva proposed inclusion of "sub-set", not a superset and I provided my reasoning about why I chose not to go with it here: #1600 (comment)

@camilamacedo86
Copy link
Contributor

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 15, 2025
@camilamacedo86 camilamacedo86 added this pull request to the merge queue Jan 15, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 15, 2025
@azych azych force-pushed the doc-comment-blang branch from 1de864f to e562d1f Compare January 16, 2025 08:29
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 16, 2025
Copy link

openshift-ci bot commented Jan 16, 2025

New changes are detected. LGTM label has been removed.

@camilamacedo86 camilamacedo86 added this pull request to the merge queue Jan 16, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 16, 2025
@camilamacedo86 camilamacedo86 added this pull request to the merge queue Jan 16, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 16, 2025
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