[FAQ, CI] Apply Dubbo Error Code Inspector in GitHub Actions

[win120a]

相关 PR / Related PRs

原先的 PR / Legacy PR: #10663 检查机制的实现的 PR / The inspector code implementation: https://github.com/apache/dubbo-test-tools/pull/1

介绍 / Introduction

这个 PR 实现了在 GitHub Actions 中 warn, error 链接指向的检查机制。

This pull request implements the mechanism that checks (document links of) error code in logger invocations.

功能 / Features

中文

1. 代码中全部错误码的提取 （见下述截图中的 All Error Codes 部分）
2. 错误码文档链接失效的判定 （见下述截图中的 Error codes which document links are not reachable 部分）
3. 未用错误码的 Logger 方法的提示 （见下述截图中的 Illegal logger method invocations 部分）
4. GitHub Actions 的自动检查。（目前不会抛出异常。其会将结果上传到 GitHub 的 Artifacts。）

English

1. Error code extraction. ('All Error Codes' in screenshot)
2. Link testing of document of error codes. ('Error codes which document links are not reachable' in screenshot)
3. Hint of logger method invocations which don't use error code. ('Illegal logger method invocations' in screenshot)
4. Automatic checking in GitHub Actions. (Currently it does not throw exception. It will upload result to artifacts in GitHub Actions.)

Actions 的运行截图 / Screenshot in GitHub Actions

运行 / Run

GitHub Actions 自动运行 / Automatically run in GitHub Actions

GitHub Actions 会在代码推送时自动运行本程序。可以到 Artifacts 下载 GitHub Actions 的运行结果。文件名为 error-inspection-result.txt。

This program will be executed by GitHub Actions when someone pushes patches. The result can be downloaded in 'Artifacts' section. The file name of report is error-inspection-result.txt.

[codecov-commenter]

Codecov Report

Merging #10680 (6765fc7) into 3.1 (14fb253) will decrease coverage by 0.01%. The diff coverage is n/a.

@@             Coverage Diff              @@
##                3.1   #10680      +/-   ##
============================================
- Coverage     65.24%   65.23%   -0.02%     
- Complexity      493      494       +1     
============================================
  Files          1336     1336              
  Lines         56922    56922              
  Branches       8435     8435              
============================================
- Hits          37140    37131       -9     
- Misses        15812    15824      +12     
+ Partials       3970     3967       -3     

Impacted Files	Coverage Δ
.../remoting/api/SingleProtocolConnectionManager.java	61.53% <0.00%> (-23.08%)	:arrow_down:
...g/apache/dubbo/remoting/api/ConnectionHandler.java	51.51% <0.00%> (-9.10%)	:arrow_down:
...e/dubbo/rpc/protocol/tri/transport/WriteQueue.java	73.80% <0.00%> (-4.77%)	:arrow_down:
...etadata/report/support/AbstractMetadataReport.java	69.09% <0.00%> (-2.28%)	:arrow_down:
...dubbo/rpc/cluster/directory/AbstractDirectory.java	80.51% <0.00%> (-1.95%)	:arrow_down:
...bbo/common/resource/GlobalResourcesRepository.java	63.07% <0.00%> (-1.54%)	:arrow_down:
...java/org/apache/dubbo/remoting/api/Connection.java	80.00% <0.00%> (-0.84%)	:arrow_down:
...rg/apache/dubbo/common/timer/HashedWheelTimer.java	85.22% <0.00%> (-0.69%)	:arrow_down:
...he/dubbo/registry/zookeeper/ZookeeperRegistry.java	61.05% <0.00%> (-0.53%)	:arrow_down:
...ubbo/registry/client/AbstractServiceDiscovery.java	82.83% <0.00%> (ø)
... and 7 more

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more