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: adding a v1beta1 deprecation notice #6000

Merged
merged 2 commits into from May 13, 2024
Merged

Conversation

shawkins
Copy link
Contributor

Description

closes: #5947

Another deprecation notice about the annotation processing crd generator can be added after the plugins are ready.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change
  • Chore (non-breaking change which doesn't affect codebase;
    test, version modification, documentation, etc.)

Checklist

  • Code contributed by me aligns with current project license: Apache 2.0
  • I Added CHANGELOG entry regarding this change
  • I have implemented unit tests to cover my changes
  • I have added/updated the javadocs and other documentation accordingly
  • No new bugs, code smells, etc. in SonarCloud report
  • I tested my code in Kubernetes
  • I tested my code in OpenShift

@manusa manusa self-assigned this May 13, 2024
Signed-off-by: Marc Nuri <marc@marcnuri.com>
@manusa
Copy link
Member

manusa commented May 13, 2024

I added a couple of deprecation warnings and a log statement in 41fed05

Please @shawkins check if this makes sense.

@manusa manusa requested a review from rohanKanojia May 13, 2024 12:39
@shawkins
Copy link
Contributor Author

Please @shawkins check if this makes sense.

The log helps. The class deprecations I really hope are not needed - if anyone is that far into the weeds of the CRD logic we probably need to think more about making classes more locked down to minimize the supported surface area.

@manusa
Copy link
Member

manusa commented May 13, 2024

The class deprecations I really hope are not needed

I hope so too. I'd also advocate for making things as closed as possible. (e.g. in crdv2 I see many public things that could have a more restricted access)

In any case, for me this is useful since it serves as a marker to remove deprecated classes when we start v7 development.

Copy link

sonarcloud bot commented May 13, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
E Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

@manusa manusa added this to the 6.13.0 milestone May 13, 2024 — with automated-tasks
Copy link
Member

@manusa manusa left a comment

Choose a reason for hiding this comment

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

LGTM, thx!

@manusa manusa merged commit 74dac08 into fabric8io:main May 13, 2024
20 of 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.

Deprecate v1beta1 crd generation
4 participants