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

[Core] Deprecate TypeRegistryConfigurer #1799

Merged
merged 4 commits into from
Oct 18, 2019
Merged

Conversation

rasklaad
Copy link

Deprecated TypeRegistryConfigurer, added more examples, how to use new configuration.

Motivation and Context

#1797

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist:

  • I've added tests for my code.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Annotation based configuration example
Lambda style configuration example
@coveralls
Copy link

coveralls commented Oct 11, 2019

Coverage Status

Coverage remained the same at 87.177% when pulling d22ec48 on type-registry-deprecation into 50e39f6 on master.

@@ -6,8 +6,12 @@

/**
* The type registry configurer allows to configure a new type registry and the locale.
* @deprecated Please use annotation based configuration.
* See <a href="https://github.com/cucumber/cucumber-jvm/blob/master/examples/java-calculator/src/test/java/io/cucumber/examples/java/ShoppingSteps.java">Annotation based example</a>
* See <a href="https://github.com/cucumber/cucumber-jvm/blob/master/examples/java8-calculator/src/test/java/io/cucumber/examples/java8/ShoppingSteps.java">Lambda based example</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally this should link to the documentation pages rather then github examples.

Copy link
Author

Choose a reason for hiding this comment

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

I can't really change configuration page in the docs repo before v5 release. This could mislead users.

So I'll change this links to https://cucumber.io/docs/cucumber/configuration/ after v5 release.

Copy link
Contributor

Choose a reason for hiding this comment

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

We also don't have to introduce this in 5.0.0. I'd rather have the docs in order so there is a clear way out before we deprecate it.

Copy link
Contributor

Choose a reason for hiding this comment

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

So. I was planning to do this in in v5.x rather then v5.0 because it would make updating the documentation a bit easier but since we're working with release candidates now I think we can prepare the MR for v5.0 along with the release of v5.0.

@mpkorstanje mpkorstanje added this to the 5.x.x milestone Oct 11, 2019
@mpkorstanje mpkorstanje changed the title TypeRegistryConfigurer deprecation [Core] Deprecate TypeRegistryConfigurer Oct 18, 2019
@mpkorstanje mpkorstanje merged commit bd4cd22 into master Oct 18, 2019
@mpkorstanje mpkorstanje deleted the type-registry-deprecation branch October 18, 2019 10:18
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