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

deprecate-api validator: add checks for removed APIs on 1.25 and 1.26 #208

Merged
merged 1 commit into from
Jan 24, 2022
Merged

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Dec 12, 2021

Description
deprecate-api validator: add checks for removed APIs on 1.25 and 1.26

Motivation
If we found the removed APIs for 1.25 and 1.26 raise the warnings and errors accordingly.

Co-authored-by: Brett Tofel btofel@redhat.com

Closes: #151
Closes: #157

@bentito
Copy link
Contributor

bentito commented Dec 13, 2021

/lgtm

@openshift-ci openshift-ci bot added lgtm Indicates that a PR is ready to be merged. and removed lgtm Indicates that a PR is ready to be merged. labels Dec 13, 2021
@bentito
Copy link
Contributor

bentito commented Dec 13, 2021

/lgtm

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

@gallettilance gallettilance left a comment

Choose a reason for hiding this comment

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

Looks good! Can you please add an example of how to call this validation in the README?

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Dec 15, 2021
@camilamacedo86
Copy link
Contributor Author

HI @gallettilance,

The README and the validator doc for the golang docs were supplemented. Thank you for your review. 🥇

@openshift-ci openshift-ci bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Dec 15, 2021
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pkg/validation/internal/removed_apis.go Outdated Show resolved Hide resolved
pkg/validation/internal/removed_apis_test.go Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@gallettilance gallettilance left a comment

Choose a reason for hiding this comment

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

/lgtm one nit: if they use these optional validators it would be good to produce a warning saying "deprecated apis were not detected. this validator cannot check operator code for the use of deprecated apis. please check your operator code to ensure that deprecated apis aren't in use." (something like that)

@camilamacedo86
Copy link
Contributor Author

camilamacedo86 commented Dec 16, 2021

Hi @gallettilance:

/lgtm one nit: if they use these optional validators it would be good to produce a warning saying "deprecated apis were not detected. this validator cannot check operator code for the use of deprecated apis. please check your operator code to ensure that deprecated apps aren't in use." (something like that)

The validators just raise warnings or errors (no info level logs #158). If we always introduce a warn by default, how can we easily identify when the checks passed successfully (nothing to report, not found) when not? For example, I want my report shows the result in yellow when any warning is raised and in red when we found an issue.

I think that would be nice to be provided if we be able to do #158 and began to have an info level then, we could add this info by default.

@ankitathomas
Copy link
Contributor

/lgtm

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

@dinhxuanvu dinhxuanvu left a comment

Choose a reason for hiding this comment

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

/approve

@openshift-ci
Copy link

openshift-ci bot commented Jan 24, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, dinhxuanvu

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-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2022
@openshift-merge-robot openshift-merge-robot merged commit bfa93d1 into operator-framework:master Jan 24, 2022
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.

None yet

7 participants