Skip to content

Commit

Permalink
upgrade doc version (#544)
Browse files Browse the repository at this point in the history
* upgrade doc version

* fix 3.3.1 bug

* fix TripleConstants import not found

* update doc

---------

Co-authored-by: Mac <[email protected]>
  • Loading branch information
songxiaosheng and Mac authored Nov 8, 2024
1 parent a699652 commit 4228206
Show file tree
Hide file tree
Showing 17 changed files with 105 additions and 36 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# dubbo-spi-extensions
[![Build and Test For PR](https://github.com/apache/dubbo-spi-extensions/actions/workflows/build-and-test-pr.yml/badge.svg)](https://github.com/apache/dubbo-spi-extensions/actions/workflows/build-and-test-pr.yml)
[![Build Status](https://travis-ci.org/apache/dubbo-spi-extensions.svg?branch=master)](https://travis-ci.org/apache/dubbo-spi-extensions)
[![codecov](https://codecov.io/gh/apache/dubbo-spi-extensions/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-spi-extensions)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo.extensions/extensions-parent.svg)](https://search.maven.org/search?q=g:org.apache.dubbo.extensions)
[![License](https://img.shields.io/github/license/apache/dubbo.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo/dubbo-spi-extensions.svg)](https://search.maven.org/search?q=g:org.apache.dubbo%20AND%20a:dubbo-spi-extensions)
[![GitHub release](https://img.shields.io/github/release/apache/dubbo-spi-extensions.svg)]

[中文](./README_CN.md)

Expand All @@ -20,6 +20,7 @@ The available extensions are as follows:
- [dubbo-api-docs-annotations](dubbo-api-docs/dubbo-api-docs-annotations)
- [dubbo-api-docs-core](dubbo-api-docs/dubbo-api-docs-core)
- [dubbo-api-docs-examples](dubbo-api-docs/dubbo-api-docs-examples)
- [dubbo-build-tools](dubbo-build-tools)
- [dubbo-cluster-extensions](dubbo-cluster-extensions)
- [dubbo-cluster-broadcast-1](dubbo-cluster-extensions/dubbo-cluster-broadcast-1)
- [dubbo-cluster-loadbalance-peakewma](dubbo-cluster-extensions/dubbo-cluster-loadbalance-peakewma)
Expand Down Expand Up @@ -50,6 +51,7 @@ The available extensions are as follows:
- [dubbo-metadata-report-extensions](dubbo-metadata-report-extensions)
- [dubbo-metadata-report-consul](dubbo-metadata-report-extensions/dubbo-metadata-report-consul)
- [dubbo-metadata-report-etcd](dubbo-metadata-report-extensions/dubbo-metadata-report-etcd)
- [dubbo-metadata-report-redis](dubbo-metadata-report-extensions/dubbo-metadata-report-redis)
- [dubbo-metadata-rest](dubbo-metadata-report-extensions/dubbo-metadata-rest)
- [dubbo-mock-extensions](dubbo-mock-extensions)
- [dubbo-mock-admin](dubbo-mock-extensions/dubbo-mock-admin)
Expand Down Expand Up @@ -90,6 +92,7 @@ The available extensions are as follows:
- [dubbo-serialization-fury](dubbo-serialization-extensions/dubbo-serialization-fury)
- [dubbo-serialization-gson](dubbo-serialization-extensions/dubbo-serialization-gson)
- [dubbo-serialization-jackson](dubbo-serialization-extensions/dubbo-serialization-jackson)
- [dubbo-serialization-jdk](dubbo-serialization-extensions/dubbo-serialization-jdk)
- [dubbo-serialization-kryo](dubbo-serialization-extensions/dubbo-serialization-kryo)
- [dubbo-serialization-msgpack](dubbo-serialization-extensions/dubbo-serialization-msgpack)
- [dubbo-serialization-native-hessian](dubbo-serialization-extensions/dubbo-serialization-native-hessian)
Expand Down
9 changes: 6 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# dubbo-spi-extensions
[![Build and Test For PR](https://github.com/apache/dubbo-spi-extensions/actions/workflows/build-and-test-pr.yml/badge.svg)](https://github.com/apache/dubbo-spi-extensions/actions/workflows/build-and-test-pr.yml)
[![Build Status](https://travis-ci.org/apache/dubbo-spi-extensions.svg?branch=master)](https://travis-ci.org/apache/dubbo-spi-extensions)
[![codecov](https://codecov.io/gh/apache/dubbo-spi-extensions/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-spi-extensions)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo.extensions/extensions-parent.svg)](https://search.maven.org/search?q=g:org.apache.dubbo.extensions)
[![License](https://img.shields.io/github/license/apache/dubbo.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo/dubbo-spi-extensions.svg)](https://search.maven.org/search?q=g:org.apache.dubbo%20AND%20a:dubbo-spi-extensions)
[![GitHub release](https://img.shields.io/github/release/apache/dubbo-spi-extensions.svg)]

[English](./README.md)

Expand All @@ -20,6 +20,7 @@ dubbo-spi-extensions的目的是提供开放的、社区驱动的、可重用的
- [dubbo-api-docs-annotations](dubbo-api-docs/dubbo-api-docs-annotations)
- [dubbo-api-docs-core](dubbo-api-docs/dubbo-api-docs-core)
- [dubbo-api-docs-examples](dubbo-api-docs/dubbo-api-docs-examples)
- [dubbo-build-tools](dubbo-build-tools)
- [dubbo-cluster-extensions](dubbo-cluster-extensions)
- [dubbo-cluster-broadcast-1](dubbo-cluster-extensions/dubbo-cluster-broadcast-1)
- [dubbo-cluster-loadbalance-peakewma](dubbo-cluster-extensions/dubbo-cluster-loadbalance-peakewma)
Expand Down Expand Up @@ -50,6 +51,7 @@ dubbo-spi-extensions的目的是提供开放的、社区驱动的、可重用的
- [dubbo-metadata-report-extensions](dubbo-metadata-report-extensions)
- [dubbo-metadata-report-consul](dubbo-metadata-report-extensions/dubbo-metadata-report-consul)
- [dubbo-metadata-report-etcd](dubbo-metadata-report-extensions/dubbo-metadata-report-etcd)
- [dubbo-metadata-report-redis](dubbo-metadata-report-extensions/dubbo-metadata-report-redis)
- [dubbo-metadata-rest](dubbo-metadata-report-extensions/dubbo-metadata-rest)
- [dubbo-mock-extensions](dubbo-mock-extensions)
- [dubbo-mock-admin](dubbo-mock-extensions/dubbo-mock-admin)
Expand Down Expand Up @@ -90,6 +92,7 @@ dubbo-spi-extensions的目的是提供开放的、社区驱动的、可重用的
- [dubbo-serialization-fury](dubbo-serialization-extensions/dubbo-serialization-fury)
- [dubbo-serialization-gson](dubbo-serialization-extensions/dubbo-serialization-gson)
- [dubbo-serialization-jackson](dubbo-serialization-extensions/dubbo-serialization-jackson)
- [dubbo-serialization-jdk](dubbo-serialization-extensions/dubbo-serialization-jdk)
- [dubbo-serialization-kryo](dubbo-serialization-extensions/dubbo-serialization-kryo)
- [dubbo-serialization-msgpack](dubbo-serialization-extensions/dubbo-serialization-msgpack)
- [dubbo-serialization-native-hessian](dubbo-serialization-extensions/dubbo-serialization-native-hessian)
Expand Down
4 changes: 2 additions & 2 deletions dubbo-api-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Adding some annotations can generate a swagger like document without turning a n
## Involving repositorys

* [dubbo-spi-extensions](https://github.com/apache/dubbo-spi-extensions)
[\branch: 3.3.0\dubbo-api-docs](https://github.com/apache/dubbo-spi-extensions/tree/3.3.0/dubbo-api-docs):
[\branch: 3.3.1\dubbo-api-docs](https://github.com/apache/dubbo-spi-extensions/tree/3.3.0/dubbo-api-docs):
Dubbo-Api-Docs related annotation ,annotation parsing
* [dubbo-admin](https://github.com/KeRan213539/dubbo-admin): Dubbo-Api-Docs document display, test function

Expand All @@ -25,7 +25,7 @@ Adding some annotations can generate a swagger like document without turning a n
* Of course, Dubbo API Docs consumed a little CPU resources when the project starting and used a little memory
for caching. In the future, it will consider putting the contents of the cache into the metadata center

### Current Version: 3.3.0
### Current Version: 3.3.1

```
<dependency>
Expand Down
4 changes: 2 additions & 2 deletions dubbo-api-docs/README_ch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dubbo 接口文档、测试工具,根据注解生成文档,并提供测试功能
## 相关项目

* [dubbo-spi-extensions](https://github.com/apache/dubbo-spi-extensions)
[\分支: 3.3.0\dubbo-api-docs](https://github.com/apache/dubbo-spi-extensions/tree/3.3.0/dubbo-api-docs):
[\分支: 3.3.1\dubbo-api-docs](https://github.com/apache/dubbo-spi-extensions/tree/3.3.0/dubbo-api-docs):
Dubbo-Api-Docs 相关注解,解析注解
* [dubbo-admin](https://github.com/KeRan213539/dubbo-admin): Dubbo-Api-Docs 文档展示,测试功能

Expand All @@ -22,7 +22,7 @@ dubbo 接口文档、测试工具,根据注解生成文档,并提供测试功能
* 为避免增加生产环境中的资源占用, 建议单独创建一个配制类用于启用Dubbo Api Docs, 并配合 @Profile("dev") 注解使用
* 当然, Dubbo Api Docs 仅在项目启动时多消耗了点CPU资源, 并使用了一点点内存用于缓存, 将来会考虑将缓存中的内容放到元数据中心.

### 当前版本: 3.3.0
### 当前版本: 3.3.1

```
<dependency>
Expand Down
30 changes: 30 additions & 0 deletions dubbo-build-tools/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-build-tools</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>

<properties>
<maven.deploy.skip>true</maven.deploy.skip>
</properties>

</project>
16 changes: 16 additions & 0 deletions dubbo-build-tools/src/main/resources/checkstyle-header.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
26 changes: 19 additions & 7 deletions dubbo-extensions-dependencies-bom/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
<!-- Fabric8 for Kubernetes -->
<fabric8_kubernetes_version>6.13.4</fabric8_kubernetes_version>
<hessian_version>4.0.66</hessian_version>
<hession-lite.version>3.2.13</hession-lite.version>
<httpclient_version>4.5.14</httpclient_version>
<jsonrpc_version>1.2.0</jsonrpc_version>
<portlet_version>2.0</portlet_version>
Expand Down Expand Up @@ -190,7 +191,18 @@
<type>pom</type>
<scope>import</scope>
</dependency>

<dependency>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-serialization-jdk</artifactId>
<version>${revision}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-remoting-http</artifactId>
<version>${revision}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>io.fabric8</groupId>
<artifactId>kubernetes-client</artifactId>
Expand Down Expand Up @@ -223,7 +235,11 @@
<version>${spring.version}</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>hessian-lite</artifactId>
<version>${hession-lite.version}</version>
</dependency>
<dependency>
<groupId>com.caucho</groupId>
<artifactId>hessian</artifactId>
Expand Down Expand Up @@ -254,6 +270,7 @@
<artifactId>libthrift</artifactId>
<version>${thrift_version}</version>
</dependency>

<dependency>
<groupId>redis.clients</groupId>
<artifactId>jedis</artifactId>
Expand Down Expand Up @@ -325,11 +342,6 @@
<artifactId>fury-core</artifactId>
<version>${apache.fury_version}</version>
</dependency>
<dependency>
<groupId>org.apache.fury</groupId>
<artifactId>fury-core</artifactId>
<version>${apache.fury_version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
Expand Down
4 changes: 4 additions & 0 deletions dubbo-metadata-report-extensions/dubbo-metadata-rest/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -153,5 +153,9 @@
<artifactId>dubbo-metrics-metadata</artifactId>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
import static org.apache.dubbo.metadata.annotation.processing.util.AnnotationUtils.getAnnotation;
import static org.apache.dubbo.metadata.annotation.processing.util.AnnotationUtils.getValue;
import static org.apache.dubbo.metadata.annotation.processing.util.AnnotationUtils.isAnnotationPresent;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.CONSUMES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.HTTP_METHOD_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.PATH_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.PRODUCES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.CONSUMES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.HTTP_METHOD_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.PATH_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.PRODUCES_ANNOTATION_CLASS_NAME;



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@
import static org.apache.dubbo.common.utils.AnnotationUtils.getValue;
import static org.apache.dubbo.common.utils.AnnotationUtils.isAnnotationPresent;
import static org.apache.dubbo.common.utils.PathUtils.buildPath;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.CONSUMES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.HTTP_METHOD_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.PATH_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.rest.RestMetadataConstants.JAX_RS.PRODUCES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.CONSUMES_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.HTTP_METHOD_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.PATH_ANNOTATION_CLASS_NAME;
import static org.apache.dubbo.metadata.extension.rest.api.RestMetadataConstants.JAX_RS.PRODUCES_ANNOTATION_CLASS_NAME;

/**
* JAX-RS {@link ServiceRestMetadataResolver} implementation
Expand Down
4 changes: 2 additions & 2 deletions dubbo-rpc-extensions/dubbo-rpc-hessian/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-remoting-http</artifactId>
<optional>true</optional>
</dependency>
Expand All @@ -57,7 +57,7 @@
<artifactId>httpclient</artifactId>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-serialization-jdk</artifactId>
<scope>test</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion dubbo-rpc-extensions/dubbo-rpc-http/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-remoting-http</artifactId>
<optional>true</optional>
</dependency>
Expand Down
5 changes: 3 additions & 2 deletions dubbo-rpc-extensions/dubbo-rpc-native-thrift/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,14 @@
<artifactId>libthrift</artifactId>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-serialization-jdk</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-remoting-zookeeper</artifactId>
<artifactId>dubbo-remoting-zookeeper-curator5</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
Expand Down
2 changes: 1 addition & 1 deletion dubbo-rpc-extensions/dubbo-rpc-redis/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-serialization-jdk</artifactId>
<scope>test</scope>
</dependency>
Expand Down
2 changes: 1 addition & 1 deletion dubbo-rpc-extensions/dubbo-rpc-rest/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@
</dependency>

<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-serialization-jdk</artifactId>
<scope>test</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import org.apache.dubbo.rpc.model.ModuleModel;
import org.apache.dubbo.rpc.model.ProviderModel;
import org.apache.dubbo.rpc.model.ServiceDescriptor;
import org.apache.dubbo.rpc.protocol.tri.TripleConstant;
import org.apache.dubbo.rpc.protocol.tri.TripleConstants;
import org.apache.dubbo.rpc.support.RpcUtils;

import java.io.IOException;
Expand Down Expand Up @@ -222,8 +222,8 @@ public Object decode(Channel channel, InputStream input) throws IOException {
return this;
}
private static String convertHessianFromWrapper(String serializeType) {
if (TripleConstant.HESSIAN4.equals(serializeType)) {
return TripleConstant.HESSIAN2;
if (TripleConstants.HESSIAN4.equals(serializeType)) {
return TripleConstants.HESSIAN2;
}
return serializeType;
}
Expand Down
2 changes: 1 addition & 1 deletion dubbo-rpc-extensions/dubbo-rpc-webservice/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.dubbo</groupId>
<groupId>org.apache.dubbo.extensions</groupId>
<artifactId>dubbo-remoting-http</artifactId>
<optional>true</optional>
</dependency>
Expand Down

0 comments on commit 4228206

Please sign in to comment.