optimize: optimize pom description (apache#4721)

shuaijiangya · Jun 22, 2022 · 48a7581 · 48a7581
1 parent 285a24b
commit 48a7581
Show file tree

Hide file tree

Showing 86 changed files with 101 additions and 8 deletions.
diff --git a/build/pom.xml b/build/pom.xml
@@ -25,7 +25,7 @@
     <version>${revision}</version>
 
     <name>Seata Build ${project.version}</name>
-
+    <description>plugin management for Seata built with Maven</description>
     <licenses>
         <license>
             <name>Apache License, Version 2.0</name>

diff --git a/changes/en-us/develop.md b/changes/en-us/develop.md
@@ -22,6 +22,7 @@ Add changes here for all PR submitted to the develop branch.
   - [[#4693](https://github.com/seata/seata/pull/4693)] optimize the console navigation bar
   - [[#4544](https://github.com/seata/seata/pull/4544)] optimize jackson dependencies in TransactionContextFilterTest
   - [[#4700](https://github.com/seata/seata/pull/4700)] fix maven-compiler-plugin and maven-resources-plugin execute failed
+  - [[#4720](https://github.com/seata/seata/pull/4720)] optimize pom description
 
 ### test:
 

diff --git a/changes/zh-cn/develop.md b/changes/zh-cn/develop.md
@@ -20,6 +20,7 @@
   - [[#4693](https://github.com/seata/seata/pull/4693)] 优化控制台导航栏
   - [[#4544](https://github.com/seata/seata/pull/4544)] 优化测试用例TransactionContextFilterTest中jackson包依赖问题
   - [[#4700](https://github.com/seata/seata/pull/4700)] 修复 maven-compiler-plugin 和 maven-resources-plugin 执行失败
+  - [[#4720](https://github.com/seata/seata/pull/4720)] 优化pom描述
 
 ### test：
 

diff --git a/common/pom.xml b/common/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-common</artifactId>
     <packaging>jar</packaging>
     <name>seata-common ${project.version}</name>
+    <description>common library for Seata built with Maven</description>
     <dependencies>
         <dependency>
             <groupId>io.netty</groupId>

diff --git a/compressor/pom.xml b/compressor/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor</artifactId>
     <packaging>pom</packaging>
     <name>seata-compressor ${project.version}</name>
+    <description>compressor top parent for Seata built with Maven</description>
 
     <modules>
         <module>seata-compressor-all</module>

diff --git a/compressor/seata-compressor-7z/pom.xml b/compressor/seata-compressor-7z/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-7z</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-7z ${project.version}</name>
+    <description>compressor-7z for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-all/pom.xml b/compressor/seata-compressor-all/pom.xml
@@ -25,6 +25,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-compressor-all</artifactId>
     <name>seata-compressor-all ${project.version}</name>
+    <description>compressor-all for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-bzip2/pom.xml b/compressor/seata-compressor-bzip2/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-bzip2</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-bzip2 ${project.version}</name>
+    <description>compressor-bzip2 for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-deflater/pom.xml b/compressor/seata-compressor-deflater/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-deflater</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-deflater ${project.version}</name>
+    <description>compressor-deflater for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-gzip/pom.xml b/compressor/seata-compressor-gzip/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-gzip</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-gzip ${project.version}</name>
+    <description>compressor-gzip for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-lz4/pom.xml b/compressor/seata-compressor-lz4/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-lz4</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-lz4 ${project.version}</name>
+    <description>compressor-lz4 for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-zip/pom.xml b/compressor/seata-compressor-zip/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-zip</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-zip ${project.version}</name>
+    <description>compressor-zip for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/compressor/seata-compressor-zstd/pom.xml b/compressor/seata-compressor-zstd/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-compressor-zstd</artifactId>
     <packaging>jar</packaging>
     <name>seata-compressor-zstd ${project.version}</name>
+    <description>compressor-zstd for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/pom.xml b/config/pom.xml
@@ -26,6 +26,8 @@
     <artifactId>seata-config</artifactId>
     <packaging>pom</packaging>
     <name>seata-config ${project.version}</name>
+    <description>config top parent for Seata built with Maven</description>
+
     <modules>
         <module>seata-config-core</module>
         <module>seata-config-custom</module>

diff --git a/config/seata-config-all/pom.xml b/config/seata-config-all/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-all</artifactId>
     <name>seata-config-all ${project.version}</name>
+    <description>config-all for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-apollo/pom.xml b/config/seata-config-apollo/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-apollo</artifactId>
     <name>seata-config-apollo ${project.version}</name>
+    <description>config-apollo for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-consul/pom.xml b/config/seata-config-consul/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-consul</artifactId>
     <name>seata-config-consul ${project.version}</name>
+    <description>config-consul for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-core/pom.xml b/config/seata-config-core/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-core</artifactId>
     <name>seata-config-core ${project.version}</name>
+    <description>config-core for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-custom/pom.xml b/config/seata-config-custom/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-custom</artifactId>
     <name>seata-config-custom ${project.version}</name>
+    <description>config-custom for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-etcd3/pom.xml b/config/seata-config-etcd3/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-etcd3</artifactId>
     <name>seata-config-etcd3 ${project.version}</name>
+    <description>config-etcd3 for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-nacos/pom.xml b/config/seata-config-nacos/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-nacos</artifactId>
     <name>seata-config-nacos ${project.version}</name>
+    <description>config-nacos for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/config/seata-config-spring-cloud/pom.xml b/config/seata-config-spring-cloud/pom.xml
@@ -11,6 +11,8 @@
 
     <artifactId>seata-config-spring-cloud</artifactId>
     <name>seata-config-spring-cloud ${project.version}</name>
+    <description>config-spring-cloud for Seata built with Maven</description>
+
     <dependencies>
         <dependency>
             <groupId>io.seata</groupId>

diff --git a/config/seata-config-zk/pom.xml b/config/seata-config-zk/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-config-zk</artifactId>
     <name>seata-config-zk ${project.version}</name>
+    <description>config-zookeeper for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/console/pom.xml b/console/pom.xml
@@ -11,6 +11,7 @@
     <artifactId>seata-console</artifactId>
     <packaging>jar</packaging>
     <name>seata-console ${project.version}</name>
+    <description>console for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/core/pom.xml b/core/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-core</artifactId>
     <packaging>jar</packaging>
     <name>seata-core ${project.version}</name>
+    <description>core for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/dependencies/pom.xml b/dependencies/pom.xml
@@ -29,7 +29,7 @@
     <packaging>pom</packaging>
 
     <name>Seata dependencies ${project.version}</name>
-    <description>Seata dependencies</description>
+    <description>dependencies for Seata built with Maven</description>
 
     <properties>
         <dubbo.version>2.7.4</dubbo.version>

diff --git a/discovery/pom.xml b/discovery/pom.xml
@@ -27,6 +27,8 @@
     <packaging>pom</packaging>
     <artifactId>seata-discovery</artifactId>
     <name>seata-discovery ${project.version}</name>
+    <description>discovery top parent for Seata built with Maven</description>
+
     <modules>
         <module>seata-discovery-consul</module>
         <module>seata-discovery-core</module>

diff --git a/discovery/seata-discovery-all/pom.xml b/discovery/seata-discovery-all/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-all</artifactId>
     <name>seata-discovery-all ${project.version}</name>
+    <description>discovery-all for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-consul/pom.xml b/discovery/seata-discovery-consul/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-consul</artifactId>
     <name>seata-discovery-consul ${project.version}</name>
+    <description>discovery-consul for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-core/pom.xml b/discovery/seata-discovery-core/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-core</artifactId>
     <name>seata-discovery-core ${project.version}</name>
+    <description>discovery-core for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-custom/pom.xml b/discovery/seata-discovery-custom/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-custom</artifactId>
     <name>seata-discovery-custom ${project.version}</name>
+    <description>discovery-custom for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-etcd3/pom.xml b/discovery/seata-discovery-etcd3/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-etcd3</artifactId>
     <name>seata-discovery-etcd3 ${project.version}</name>
+    <description>discovery-etcd3 for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-eureka/pom.xml b/discovery/seata-discovery-eureka/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-eureka</artifactId>
     <name>seata-discovery-eureka ${project.version}</name>
+    <description>discovery-eureka for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-nacos/pom.xml b/discovery/seata-discovery-nacos/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-nacos</artifactId>
     <name>seata-discovery-nacos ${project.version}</name>
+    <description>discovery-nacos for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-redis/pom.xml b/discovery/seata-discovery-redis/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-redis</artifactId>
     <name>seata-discovery-redis ${project.version}</name>
+    <description>discovery-redis for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-sofa/pom.xml b/discovery/seata-discovery-sofa/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-sofa</artifactId>
     <name>seata-discovery-sofa ${project.version}</name>
+    <description>discovery-sofa for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/discovery/seata-discovery-zk/pom.xml b/discovery/seata-discovery-zk/pom.xml
@@ -24,6 +24,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-discovery-zk</artifactId>
     <name>seata-discovery-zk ${project.version}</name>
+    <description>discovery-zookeeper for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/distribution/pom.xml b/distribution/pom.xml
@@ -26,6 +26,7 @@
     <artifactId>seata-distribution</artifactId>
     <packaging>pom</packaging>
     <name>seata-distribution ${project.version}</name>
+    <description>distribution for Seata built with Maven</description>
 
     <profiles>
         <profile>

diff --git a/ext/apm-seata-skywalking-plugin/pom.xml b/ext/apm-seata-skywalking-plugin/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>apm-seata-skywalking-plugin</artifactId>
     <packaging>jar</packaging>
     <name>apm-seata-skywalking-plugin ${project.version}</name>
+    <description>skywalking plugin for Seata built with Maven</description>
 
     <properties>
         <skywalking.version>8.6.0</skywalking.version>

diff --git a/integration/brpc/pom.xml b/integration/brpc/pom.xml
@@ -13,6 +13,7 @@
     <artifactId>seata-brpc</artifactId>
     <packaging>jar</packaging>
     <name>seata-brpc ${project.version}</name>
+    <description>brpc integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/dubbo-alibaba/pom.xml b/integration/dubbo-alibaba/pom.xml
@@ -28,6 +28,7 @@
 
     <artifactId>seata-dubbo-alibaba</artifactId>
     <name>seata-dubbo-alibaba ${project.version}</name>
+    <description>alibaba dubbo integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/dubbo/pom.xml b/integration/dubbo/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-dubbo</artifactId>
     <packaging>jar</packaging>
     <name>seata-dubbo ${project.version}</name>
+    <description>apache dubbo integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/grpc/pom.xml b/integration/grpc/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-grpc</artifactId>
     <packaging>jar</packaging>
     <name>seata-grpc ${project.version}</name>
+    <description>gRPC integration for Seata built with Maven</description>
 
 
     <dependencies>

diff --git a/integration/hsf/pom.xml b/integration/hsf/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-hsf</artifactId>
     <packaging>jar</packaging>
     <name>seata-hsf ${project.version}</name>
+    <description>EDAS hsf integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/http/pom.xml b/integration/http/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-http</artifactId>
     <packaging>jar</packaging>
     <name>seata-http ${project.version}</name>
+    <description>http-client integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/motan/pom.xml b/integration/motan/pom.xml
@@ -28,6 +28,7 @@
     <artifactId>seata-motan</artifactId>
     <packaging>jar</packaging>
     <name>seata-motan ${project.version}</name>
+    <description>motan integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/integration/sofa-rpc/pom.xml b/integration/sofa-rpc/pom.xml
@@ -27,6 +27,7 @@
     <artifactId>seata-sofa-rpc</artifactId>
     <packaging>jar</packaging>
     <name>seata-sofa-rpc ${project.version}</name>
+    <description>sofa-rpc integration for Seata built with Maven</description>
 
     <dependencies>
         <dependency>

diff --git a/metrics/pom.xml b/metrics/pom.xml
@@ -26,6 +26,7 @@
     <packaging>pom</packaging>
     <artifactId>seata-metrics</artifactId>
     <name>seata-metrics ${project.version}</name>
+    <description>metrics top parent for Seata built with Maven</description>
 
     <modules>
         <module>seata-metrics-all</module>

diff --git a/metrics/seata-metrics-all/pom.xml b/metrics/seata-metrics-all/pom.xml
@@ -25,6 +25,7 @@
     <modelVersion>4.0.0</modelVersion>
     <artifactId>seata-metrics-all</artifactId>
     <name>seata-metrics-all ${project.version}</name>
+    <description>metrics-all for Seata built with Maven</description>
 
     <dependencies>
         <dependency>