java-spring-cloud icon indicating copy to clipboard operation
java-spring-cloud copied to clipboard

Rename artifacts/package

Open pavolloffay opened this issue 6 years ago • 7 comments

Follow Spring starter naming conventions

at the moment artifacts are named opentracing-spring-cloud-<module>-starter, however spring uses convention spring-boot-starter-<module>

https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter Although it's spring convention, the docs shows an example like acme-spring-boot-starter.

Rename from opentracing-spring-cloud to something else

This project is a collection of instrumentation for Spring Boot. Spring Cloud seems to be as a subset to spring boot. It anyways depends on SB.

I have a couple of proposals:

  1. opentracing-spring-boot- this is my preferred
  2. opentracing-spring-k

The rename will break users - groupId but also we should change package and configuration https://github.com/opentracing-contrib/java-spring-cloud/blob/master/instrument-starters/opentracing-spring-cloud-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json#L4

pavolloffay avatar Jun 01 '18 09:06 pavolloffay

cc @geoand @objectiser

pavolloffay avatar Jun 01 '18 09:06 pavolloffay

cc @gytis @metacosm

geoand avatar Jun 01 '18 09:06 geoand

I would also vote for 1.

objectiser avatar Jun 01 '18 09:06 objectiser

Be careful that Pivotal / Spring Boot have naming conventions for third party starters. @gytis ran into these issues before.

metacosm avatar Jun 01 '18 10:06 metacosm

https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html#boot-features-custom-starter-naming

gytis avatar Jun 01 '18 10:06 gytis

Then just mention it shouldn't star with spring-boot...

pavolloffay avatar Jun 01 '18 12:06 pavolloffay

:+1 for no.1

geoand avatar Jun 04 '18 09:06 geoand