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

Spring Cloud Alibaba Kubernetes Config module artifactId

Open DanielLiu1123 opened this issue 1 year ago • 5 comments

Which artifactId should we choose?

spring-cloud-starter-alibaba-kubernetes-config or spring-cloud-starter-kubernetes-config.

If we use spring-cloud-starter-kubernetes-config, it looks like a module of Spring Cloud Kubernetes, but have a different groupId.

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-kubernetes-config</artifactId>
</dependency>

DanielLiu1123 avatar Feb 04 '23 04:02 DanielLiu1123

我认为这样命名更好:spring-cloud-starter-alibaba-kubernetes-config

yuluo-yx avatar Feb 04 '23 04:02 yuluo-yx

补充一点,Spring Cloud Alibaba社区经过社区Steering Committee管理委员会提议与投票决定,从2023年起,社区新模块命名规则按照:spring-cloud-starter-(组件所属公司名)-(组件名)-功能名(子功能名) 进行模块命名,其中()内容表示非必须可省略,子功能名最多一级。

例如:spring-cloud-starter-alibaba-nacos-config符合以上命名规则,alibaba是组件所属公司名,nacos是组件名,config是功能名。该issue所讨论的kubernetes是由Google开发捐献给了CNCF基金会,所以命名可以叫:spring-cloud-starter-kubernetes-config,只是会跟Spring Cloud Kubernetes该项目中的一个组件artifactId相同,但是groupId还是不同的(另外这个组件改项目命名新版本已经不在使用,而是在2.0版本以后替换成了spring-cloud-kubernetes-fabric8-config,确实叫spring-cloud-starter-kubernetes-config也有可能引起用户搜索依赖时的困扰)。 image

steverao avatar Feb 04 '23 07:02 steverao

spring-cloud-starter-kubernetes-config 命名的话,可能会让用户以为这两个是同一个项目(虽然他们的groupid不同,但实际上大多数情况下只关注artifactid)。

例如Dubbo项目从Alibaba组织迁移到Apache组织,其实是同一个项目,只不过后续新版本在Apache维护: image

ruansheng8 avatar Feb 06 '23 05:02 ruansheng8

I prefer spring-cloud-starter-alibaba-kubernetes-config.

DanielLiu1123 avatar Feb 08 '23 13:02 DanielLiu1123

After the community discussion at the weekly meeting on February 16, it was decided to use spring-cloud-starter-alibaba-kubernetes-config to name the new module. This module naming exists as a special case that violates the current community new module naming rules.

steverao avatar Feb 16 '23 14:02 steverao

This issue has been open 30 days with no activity. This will be closed in 7 days.

github-actions[bot] avatar Mar 18 '24 18:03 github-actions[bot]

This issue has been automatically marked as stale because it hasn't had any recent activity.If you think this should still be open, or the problem still persists, just pop a reply in the comments and one of the maintainers will (try!) to follow up. Thank you for your interest and contribution to the Sping Cloud Alibaba Community.

github-actions[bot] avatar Mar 25 '24 18:03 github-actions[bot]