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

packagemanifests: do not list deprecated channel entries #2905

Conversation

joelanford
Copy link
Member

Description of the change:
Ignore bundles with property olm.deprecated when listing channel entries in the packagemanifests API.

Motivation for the change:
Follow up to #2893, which added the channel entry listing to the packagemanifests API. This is necessary to avoid misleading users about the set of bundles that available to install.

Architectural changes:

Testing remarks:

Reviewer Checklist

  • Implementation matches the proposed design, or proposal is updated to match implementation
  • Sufficient unit test coverage
  • Sufficient end-to-end test coverage
  • Bug fixes are accompanied by regression test(s)
  • e2e tests and flake fixes are accompanied evidence of flake testing, e.g. executing the test 100(0) times
  • tech debt/todo is accompanied by issue link(s) in comments in the surrounding code
  • Tests are comprehensible, e.g. Ginkgo DSL is being used appropriately
  • Docs updated or added to /doc
  • Commit messages sensible and descriptive
  • Tests marked as [FLAKE] are truly flaky and have an issue
  • Code is properly formatted

@openshift-ci openshift-ci bot requested review from benluddy and exdx December 6, 2022 02:46
@joelanford joelanford force-pushed the packagemanifests-ignore-deprecated branch 2 times, most recently from 8bc974b to deaca43 Compare December 6, 2022 14:59
@joelanford joelanford force-pushed the packagemanifests-ignore-deprecated branch from deaca43 to d69c934 Compare December 6, 2022 15:00
@grokspawn
Copy link
Contributor

I see good handling for olm.deprecated property in the code, but I don't see deprecation markers in the unit test. I just see a new v0.6.0 of the etcd op. Am I missing something?

@joelanford
Copy link
Member Author

@grokspawn This bit of added code ensures the 0.6.0 bundle is deprecated: https://github.com/joelanford/operator-lifecycle-manager/blob/d69c934f4e47429ee25b837edc2541a96a428e3e/pkg/package-server/provider/registry_test.go#L68-L72

@grokspawn
Copy link
Contributor

/approve

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 6, 2022
@exdx
Copy link
Member

exdx commented Dec 7, 2022

Would this be considered a change of behavior and subsequently require a version bump?

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 7, 2022
@openshift-ci
Copy link

openshift-ci bot commented Dec 7, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: exdx, grokspawn, joelanford

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 7eccf53 into operator-framework:master Dec 7, 2022
@grokspawn
Copy link
Contributor

Would this be considered a change of behavior and subsequently require a version bump?

I don't think so. In this same version timeframe we exposed the channel edges in this API and then restricted the edges we would expose.

@joelanford joelanford deleted the packagemanifests-ignore-deprecated branch October 30, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants