[apisix] branch master updated: docs: clarify that some tests depend on external services & system configuration (#4201)

[to...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tokers pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 9bfc394  docs: clarify that some tests depend on external services & system configuration (#4201)
9bfc394 is described below

commit 9bfc394ea0388f9b261db84c980819c1153b8590
Author: 罗泽轩 <sp...@gmail.com>
AuthorDate: Sun May 9 10:33:10 2021 +0800

    docs: clarify that some tests depend on external services & system configuration (#4201)
    
    Signed-off-by: spacewander <sp...@gmail.com>
---
 docs/en/latest/how-to-build.md | 2 ++
 docs/zh/latest/how-to-build.md | 1 +
 2 files changed, 3 insertions(+)

diff --git a/docs/en/latest/how-to-build.md b/docs/en/latest/how-to-build.md
index 0d1f402..662463d 100644
--- a/docs/en/latest/how-to-build.md
+++ b/docs/en/latest/how-to-build.md
@@ -108,6 +108,8 @@ see how to do it.
     * Set PERL5LIB for perl module: `export PERL5LIB=.:$PERL5LIB`
     * Run the test cases: `make test`
     * To set the path of nginx to run the test cases: `TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t`
+    * Some tests depend on external services and modified system configuration. If you want to setup a local CI environment,
+      you can refer to `ci/linux_openresty_common_runner.sh`.
 
 ### Troubleshoot Testing
 
diff --git a/docs/zh/latest/how-to-build.md b/docs/zh/latest/how-to-build.md
index 35b4526..b64eec5 100644
--- a/docs/zh/latest/how-to-build.md
+++ b/docs/zh/latest/how-to-build.md
@@ -104,6 +104,7 @@ Makefile rules:
     * 追加当前目录到perl模块目录： `export PERL5LIB=.:$PERL5LIB`
     * 直接运行：`make test`
     * 指定 nginx 二进制路径：`TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t`
+    * 部分测试需要依赖外部服务和修改系统配置。如果想要完整地构建测试环境，可以参考 `ci/linux_openresty_common_runner.sh`。
 
 ### 疑难排解测试