Merge branch '3.0' into develop

mark4z · Jun 20, 2021 · 727e346 · 727e346
2 parents 40082d4 + ca2a46f
commit 727e346
Show file tree

Hide file tree

Showing 123 changed files with 1,184 additions and 4,378 deletions.
diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
@@ -7,7 +7,6 @@ on:
     branches: "*"
 
 jobs:
-
   build:
     name: ${{ matrix.os }} - Go ${{ matrix.go_version }}
     runs-on: ${{ matrix.os }}
@@ -35,7 +34,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Cache dependencies
-      uses: actions/cache@v2.1.5
+      uses: actions/cache@v2.1.6
       with:
         # Cache
         path: ~/go/pkg/mod
@@ -69,12 +68,20 @@ jobs:
       run: |
         make verify
 
+    # This step only runs when the event type is a pull_request
+    - name: Integrate Test
+      if: ${{ github.event_name == 'pull_request' }}
+      run: |
+        chmod +x integrate_test.sh && [[ -n "${{github.event.pull_request.head.repo.full_name}}" ]] && [[ -n "${{github.event.pull_request.head.sha}}" ]] && [[ -n "${{github.base_ref}}" ]] && ./integrate_test.sh ${{github.event.pull_request.head.repo.full_name}} ${{github.event.pull_request.head.sha}} ${{github.base_ref}}
+
+    # This step only runs when the event type is a push
     - name: Integrate Test
+      if: ${{ github.event_name == 'push' }}
       run: |
-        chmod +x integrate_test.sh && [[ -n "${{github.event.pull_request.head.repo.full_name}}" ]] && [[ -n "${{github.event.pull_request.head.sha}}" ]] && ./integrate_test.sh ${{github.event.pull_request.head.repo.full_name}} ${{github.event.pull_request.head.sha}} || ./integrate_test.sh $GITHUB_REPOSITORY $GITHUB_SHA
+        chmod +x integrate_test.sh && ./integrate_test.sh $GITHUB_REPOSITORY $GITHUB_SHA $GITHUB_BASE_REF
 
     - name: Post Coverage
       run: bash <(curl -s https://codecov.io/bash)
 
     - name: Hello world
-      run: echo Hello world ${{ secrets.DING_TOKEN }} ${{ secrets.DING_SIGN }}
+      run: echo Hello world ${{ secrets.DING_TOKEN }} ${{ secrets.DING_SIGN }}
diff --git a/.gitignore b/.gitignore
@@ -38,3 +38,6 @@ config_center/apollo/mockDubbog.properties.json
 .*.sw?
 /license-header-checker-linux/
 /license-header-checker-linux.zip
+
+# macOS
+.DS_Store
diff --git a/CHANGE.md → CHANGELOG.md b/CHANGE.md → CHANGELOG.md
diff --git a/contributing.md → CONTRIBUTING.md b/contributing.md → CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Apache Dubbo-go [中文](./README_CN.md) #
+# Apache Dubbo-go
 
 [![Build Status](https://github.com/apache/dubbo-go/workflows/CI/badge.svg)](https://travis-ci.org/apache/dubbo-go)
 [![codecov](https://codecov.io/gh/apache/dubbo-go/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-go)
@@ -8,223 +8,66 @@
 
 ---
 
-Apache Dubbo Go Implementation to bridge the gap between java and go.
+[中文 🇨🇳](./README_CN.md)
 
+Apache Dubbo-go, a Dubbo implementation written in Golang, is born to bridge the gap between Java and Golang. Please visit our [official website](https://dubbogo.github.io) for the quick start and documentation.
 
-## License
-
-Apache License, Version 2.0
-
-## Release note ##
-
-[v1.5.6 - Apr 8, 2021](https://github.com/apache/dubbo-go/releases/tag/v1.5.6)
-
-[v1.5.5 - Jan 5, 2021](https://github.com/apache/dubbo-go/releases/tag/v1.5.5)
-
-[v1.4.5 - Nov 18, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.4.5)
-
-[v1.5.4 - Nov 1, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.5.4)
-
-[v1.5.3 - Sep 23, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.5.3)
-
-[v1.5.1 - Aug 23, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.5.1)
-
-[v1.5.0 - July 24, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.5.0)
-
-[v1.4.0 - Mar 17, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.4.0)
-
-[v1.3.0 - Mar 1, 2020](https://github.com/apache/dubbo-go/releases/tag/v1.3.0)
-
-[v1.2.0 - Nov 15, 2019](https://github.com/apache/dubbo-go/releases/tag/v1.2.0)
-
-[v1.1.0 - Sep 7, 2019 the first release after transferred to apache](https://github.com/apache/dubbo-go/releases/tag/v1.1.0)
-
-[v1.0.0 - May 29, 2019 compatible with dubbo v2.6.5](https://github.com/apache/dubbo-go/releases/tag/v1.0.0)
-
-## Project Architecture ##
-
-Both extension module and layered project architecture is according to Apache Dubbo (including protocol layer, registry layer, cluster layer, config layer and so on), the advantage of this arch is as following: you can implement these layered interfaces in your own way, override the default implementation of dubbo-go by calling 'extension.SetXXX' of extension, complete your special needs without modifying the source code. At the same time, you are welcome to contribute implementation of useful extension to the community.
-
-![dubbo go extend](./doc/pic/arch/dubbo-go-ext.png)
-
-If you want to know more about dubbo-go, please visit this reference [Project Architecture design](https://github.com/apache/dubbo-go/wiki/dubbo-go-V1.0-design)
+## Architecture
 
-## Feature list ##
+![dubbo go extend](https://dubbogo.github.io/img/doc/dubbo-go-arch.png)
 
-Finished List:
+Dubbo-go has been implemented most layers of Dubbo, like protocol layer, registry layer, etc. An extension module is applied to Dubbo-go in order to achieve a more flexible architecture. Developers are allowed to implement a customized layer conformed to the layer interface and use then in Dubbo-go via `extension.Set` method without modifying the source code.
 
-- Role
-    * Consumer
-    * Provider
+## Features
 
-- Transport
-    * HTTP
-    * TCP
+The features that are available for Dubbo-go are:
 
-- Codec
-    * JsonRPC V2
-    * Hessian V2
-    * [json for grpc](https://github.com/apache/dubbo-go/pull/582)
-    * protobuf
+- **Role**: Consumer, Provider
+- **Transport**: HTTP, TCP
+- **Codec**: JsonRPC V2, Hessian V2, [Json for gRPC](https://github.com/apache/dubbo-go/pull/582), Protocol Buffers
+- **Protocol**: Dubbo, [Triple](https://github.com/dubbogo/triple), JsonRPC V2, [gRPC](https://github.com/apache/dubbo-go/pull/311), [RESTful](https://github.com/apache/dubbo-go/pull/352)
+- **Router**: [Dubbo3 Router](https://github.com/apache/dubbo-go/pull/1187)
+- **Registry**: ZooKeeper, [etcd](https://github.com/apache/dubbo-go/pull/148), [Nacos](https://github.com/apache/dubbo-go/pull/151), [Consul](https://github.com/apache/dubbo-go/pull/121), [K8s](https://github.com/apache/dubbo-go/pull/400)
+- **Dynamic Configure Center & Service Management Configurator**: Zookeeper, [Apollo](https://github.com/apache/dubbo-go/pull/250), [Nacos](https://github.com/apache/dubbo-go/pull/357)
+- **Cluster Strategy**: Failover, [Failfast](https://github.com/apache/dubbo-go/pull/140), [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136), [Available](https://github.com/apache/dubbo-go/pull/155), [Broadcast](https://github.com/apache/dubbo-go/pull/158), [Forking](https://github.com/apache/dubbo-go/pull/161)
+- **Load Balance**: Random, [RoundRobin](https://github.com/apache/dubbo-go/pull/66), [LeastActive](https://github.com/apache/dubbo-go/pull/65), [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
+- **Filter**: Echo Health Check, [Circuit Break and Service Downgrade](https://github.com/apache/dubbo-go/pull/133), [TokenFilter](https://github.com/apache/dubbo-go/pull/202), [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214), [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237), [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246), [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291), [Auth/Sign](https://github.com/apache/dubbo-go/pull/323), [MetricsFilter](https://github.com/apache/dubbo-go/pull/342), [TracingFilter](https://github.com/apache/dubbo-go/pull/335)
+- **Invoke**: [Generic Invoke](https://github.com/apache/dubbo-go/pull/122)
+- **Monitor**: Opentracing API, [Prometheus](https://github.com/apache/dubbo-go/pull/342)
+- **Tracing**: [For JsonRPC](https://github.com/apache/dubbo-go/pull/335), [For Dubbo](https://github.com/apache/dubbo-go/pull/344), [For gRPC](https://github.com/apache/dubbo-go/pull/397)
+- **Metadata Center**: [Nacos(Local)](https://github.com/apache/dubbo-go/pull/522), [ZooKeeper(Local)](https://github.com/apache/dubbo-go/pull/633), [etcd(Local)](https://github.com/apache/dubbo-go/blob/9a5990d9a9c3d5e6633c0d7d926c156416bcb931/metadata/report/etcd/report.go), [Consul(Local)](https://github.com/apache/dubbo-go/pull/633), [ZooKeeper(Remoting)](https://github.com/apache/dubbo-go/pull/1161)
+- **Tool**: [Dubbo-go-cli](https://github.com/apache/dubbo-go/pull/818)
 
-- Protocol
-    * Dubbo
-    * [Triple](https://github.com/dubbogo/triple)
-    * Jsonrpc2.0
-    * [gRPC](https://github.com/apache/dubbo-go/pull/311)
-    * [RESTful](https://github.com/apache/dubbo-go/pull/352)
+## Getting started
 
-- Router
-    * [Dubbo3 router](https://github.com/apache/dubbo-go/pull/1187)
+### Install Dubbo-go v3
 
-- Registry
-    * ZooKeeper
-    * [etcd v3](https://github.com/apache/dubbo-go/pull/148)
-    * [nacos](https://github.com/apache/dubbo-go/pull/151)
-    * [consul](https://github.com/apache/dubbo-go/pull/121)
-    * [k8s](https://github.com/apache/dubbo-go/pull/400)
-
-- Dynamic Configure Center & Service Management Configurator
-    * Zookeeper
-    * [apollo](https://github.com/apache/dubbo-go/pull/250)
-    * [nacos](https://github.com/apache/dubbo-go/pull/357)
-
-- Cluster Strategy
-    * Failover
-    * [Failfast](https://github.com/apache/dubbo-go/pull/140)
-    * [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136)
-    * [Available](https://github.com/apache/dubbo-go/pull/155)
-    * [Broadcast](https://github.com/apache/dubbo-go/pull/158)
-    * [Forking](https://github.com/apache/dubbo-go/pull/161)
-
-- Load Balance
-    * Random
-    * [RoundRobin](https://github.com/apache/dubbo-go/pull/66)
-    * [LeastActive](https://github.com/apache/dubbo-go/pull/65)
-    * [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
-
-- Filter
-    * Echo Health Check
-    * [Circuit break and service downgrade](https://github.com/apache/dubbo-go/pull/133)
-    * [TokenFilter](https://github.com/apache/dubbo-go/pull/202)
-    * [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214)
-    * [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237)
-    * [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246)
-    * [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291)
-    * [Auth/Sign](https://github.com/apache/dubbo-go/pull/323)
-    * [Metrics filter](https://github.com/apache/dubbo-go/pull/342)
-    * [Tracing filter](https://github.com/apache/dubbo-go/pull/335)
-
-- Invoke
-    * [generic invoke](https://github.com/apache/dubbo-go/pull/122)
-
-- Monitor
-    * Opentracing API
-    * [Prometheus](https://github.com/apache/dubbo-go/pull/342)
-
-- Tracing
-    * [For jsonrpc](https://github.com/apache/dubbo-go/pull/335)
-    * [For dubbo](https://github.com/apache/dubbo-go/pull/344)
-    * [For grpc](https://github.com/apache/dubbo-go/pull/397)
-
-- Metadata Center
-    * [Nacos(Local)](https://github.com/apache/dubbo-go/pull/522)
-    * [Zookeeper(Local)](https://github.com/apache/dubbo-go/pull/633)
-    * [Etcd(Local)](https://github.com/apache/dubbo-go/blob/9a5990d9a9c3d5e6633c0d7d926c156416bcb931/metadata/report/etcd/report.go)
-    * [Consul(Local)](https://github.com/apache/dubbo-go/pull/633)
-    * [Zookeeper(Remoting)](https://github.com/apache/dubbo-go/pull/1161)
-
-- Tool
-    * [Dubbo-go-cli](https://github.com/apache/dubbo-go/pull/818)
-
-You can know more about dubbo-go by its [roadmap](https://github.com/apache/dubbo-go/wiki/Roadmap).
-
-![feature](./doc/pic/arch/dubbo-go-arch.png)
-
-## Document
-
-[dubbo-doc](http://dubbo.apache.org/zh/blog/) or [dubbo-go-doc-list](http://alexstocks.github.io/html/dubbogo.html)
-
-## Quick Start
-
-[dubbo-go-samples](https://github.com/apache/dubbo-go-samples) gives many examples to  tell u how to use dubbo-go. Please read the [dubbo-samples/golang/README.md](https://github.com/apache/dubbo-go-samples/blob/master/README.md) carefully to learn how to dispose the configuration and compile the program.
-
-## Running unit tests
-
-### Run
-
-```bash
-make verify
 ```
-
-### Verify license
-
-```bash
-make license
+go get dubbo.apache.org/dubbo-go/v3
 ```
 
-### Run unit test
-
-```bash
-make test
-```
+### Next steps
 
-## Build
-
-Please move to [dubbo-samples/golang](https://github.com/dubbogo/dubbo-samples)
+- [Dubbo-go Samples](https://github.com/apache/dubbo-go-samples): The project gives a series of samples that show each feature available for Dubbo-go and help you know how to integrate Dubbo-go with your system.
+- Dubbo-go Quick Start: [中文 🇨🇳](https://dubbogo.github.io/zh-cn/docs/user/quickstart/3.0/quickstart.html), [English 🇺🇸](https://dubbogo.github.io/en-us/docs/user/quick-start.html)
+- [Dubbo-go Benchmark](https://github.com/dubbogo/dubbo-go-benchmark)
+- [Dubbo-go Wiki](https://github.com/apache/dubbo-go/wiki)
 
 ## Contributing
 
-If you are willing to do some code contributions and document contributions to [Apache/dubbo-go](https://github.com/apache/dubbo-go), please visit [contribution intro](https://github.com/apache/dubbo-go/blob/master/contributing.md).
+Please visit [CONTRIBUTING](./CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
 
-## Community
+## Reporting bugs
 
-If u want to communicate with our community, pls scan the following dubbobo DingDing QR code or search our commnity DingDing group code 31363295.
+Please use the [bug report template](issues/new?template=bug-report.md) to report bugs, use the [enhancement template](issues/new?template=enhancement.md) to provide suggestions for improvement.
 
-<div>
-<table>
-  <tbody>
-  <tr></tr>
-    <tr>
-      <td align="center"  valign="middle">
-        <a href="http://alexstocks.github.io/html/dubbogo.html" target="_blank">
-          <img width="80px" height="85px" src="./doc/pic/misc/dubbogo-dingding.png">
-        </a>
-      </td>
-    </tr>
-    <tr></tr>
-  </tbody>
-</table>
-</div>
+## Contact
 
-If u want to visit the wechat group, pls add my wechat AlexanderStocks or scan the following wechat picture.
-
-<div>
-<table>
-  <tbody>
-  <tr></tr>
-    <tr>
-      <td align="center"  valign="middle">
-          <img width="80px" height="115px" src="./doc/pic/misc/dubbogo-wechat.png">
-        </a>
-      </td>
-    </tr>
-    <tr></tr>
-  </tbody>
-</table>
-</div>
-
-We welcome the friends who can give us constructing suggestions instead of known-nothing.
-
-## Benchmark
-
-Benchmark project [dubbo-go-benchmark](https://github.com/dubbogo/dubbo-go-benchmark).
-
-About dubbo-go benchmarking report, please refer to [dubbo benchmarking report](https://github.com/apache/dubbo-go/wiki/Benchmark-test-of-dubbo) & [jsonrpc benchmarking report](https://github.com/apache/dubbo-go/wiki/Benchmark-test-of-jsonrpc).
+- [DingTalk Group](https://www.dingtalk.com/en): 23331795
 
 ## [User List](https://github.com/apache/dubbo-go/issues/2)
 
-If you are using [apache/dubbo-go](https://github.com/apache/dubbo-go) and think that it helps you or want do some contributions to it, please add your company to to [the user list](https://github.com/apache/dubbo-go/issues/2) to let us know your needs.
+If you are using [apache/dubbo-go](https://github.com/apache/dubbo-go) and think that it helps you or want to contribute code for Dubbo-go, please add your company to [the user list](https://github.com/apache/dubbo-go/issues/2) to let us know your needs.
 
 
 <div>
@@ -314,5 +157,8 @@ If you are using [apache/dubbo-go](https://github.com/apache/dubbo-go) and think
 </table>
 </div>
 
-[MORE USER CASE](https://github.com/apache/dubbo-go/issues/2)
+[See more user cases](https://github.com/apache/dubbo-go/issues/2)
+
+## License
 
+Apache Dubbo-go software is licenced under the Apache License Version 2.0. See the LICENSE file for details.