...

The following Checks are REQUIRED, and only after passing these checks can the code be merged:

1. BE Code Formatter: BE C++ code format check(sh build-support/check-format.sh)
2. FE Code Style Checker: FE JAVA code format check (cd fe/ && mvn clean install -DskipTests)
3. BE UT (Clang): Run BE unit test with Clang (DORIS_TOOLCHAIN=clang ./run-be-ut.sh --run --clean)
4. BE UT (macOS): Run BE unit test on macOS (./run-be-ut.sh --run --clean)
5. BE UT (Doris BE UT): BE unit tests will be executed: sh run-be-ut.sh --run
6. FE UT (Doris FE UT): FE unit tests will be executed: sh run-fe-ut.sh --run
7. License Check: License check, will check whether all source files contain Apache License Header
8. ShellCheck: Check all shell scripts format. (sh build-support/shell-check.sh)
9. Build Extensions / Build Broker: Build Broker (cd fs_brokers/apache_hdfs_broker/ && sh build.sh)
10. Build Extensions / Build Documents: Build Documents (cd docs && /bin/bash build_help_zip.sh)
11. P0 Regression (Doris RegressionCOMPILE (DORIS_COMPILE): Will execute the compilation of FE and BE (BUILD_TYPE=ASAN sh build.sh --fe --be), then trigger P0/P1/External Regression
12. P0 Regression (Doris Regression): Will build and build the Doris environment of 1 FE and 1 BE, and execute regression  p0 test(sh run-regression-test.sh --run -g p0)
13. P1 Regression (Doris Regression): Will execute Will build the compilation Doris environment of 1 FE and 1 BE, and execute regression  p1 test(sh buildrun-regression-test.sh --fe --be), and build run -g p1)
14. External Regression (Doris External Regression): Will build the Doris environment of 1 FE and 1 BE, and execute regression  p1 regression external test(sh run-regression-test.sh --run -g external_docker)
15. performance (Doris Performance): Will execute the compilation of FE and BE (BUILD_TYPE=RELEASE sh build.sh --fe --be), build the Doris environment of 1 FE and 1 BE and execute some performance cases(see regression-test/pipeline/performance/)
16. Build Third Party Libraries (Linux): Build the third party libraries on Linux x86_64 (cd thirdparty && ./build-thirdparty.sh)
17. Build Third Party Libraries (macOS): Build the third party libraries on macOS x86_64 (cd thirdparty && ./build-thirdparty.sh)

...

2. How Checks are triggered?

All checks are automatically triggered when a Pull Request is submitted, or when the Pull Request is updated.

...

 1.The Checks 5,6,11,12,13,14,15 are triggered by TeamCity.

...

 2.The other Checks are triggered by Github Action. They will be triggered immediately after PR is submitted or updated.

The pipeline trigger on teamcity to include the run and following special keyword comments in the PULL REQUEST COMMENT section,The keyword run is also included to avoid error firing.

Key words:

        buildall: This keyword will trigger all pipelines on teamcity

        compile: This keyword will trigger the pipeline of COMPILE (DORIS_COMPILE) 

        feut: This keyword will trigger the pipeline of FE UT (Doris FE UT)

        beut: This keyword will trigger the pipeline of BE UT (Doris BE UT) 

        p0: This keyword will trigger the pipeline of P0 Regression (Doris Regression)

        p1: This keyword will trigger the pipeline of P1 Regression (Doris Regression)

        external: This keyword will trigger the pipeline of External Regression (Doris External Regression)

       performance: This keyword will trigger the pipeline of performance (Doris Performance)

       arm: This keyword will trigger the pipeline of P0 Regression (ARM pipeline)

       cloudut: This keyword will trigger the test pipeline of Cloud UT (Doris Cloud UT)

        cloud_p0: This keyword will trigger the test pipeline of cloud_p0 (Doris Cloud Regression)

        cloud_p1: This keyword will trigger the test pipeline of cloud_p1 (Doris Cloud Regression)

Note:

• To avoid error firing, you need to include both run and the specified keyword，like "run p0" , "run buildall",this is so important!

• p0,p1, and external pipeline all depend on compile-phase output, so when you want to retry one of these pipelines separately, you need to make sure that the corresponding branch has compiled output. If not, please first run the compile phase by adding the keyword with compile in the comment area of the corresponding pull request. Build the dependency pipeline after compiling.
• When you use run buildall, it means that you have triggered compile feut beut p0 p1 multiple pipelines. you need to wait for the pipeline result. It is best not to trigger the same pipeline again while waiting for the result unless the pipeline fails due to some accident

For example:

• When developers add a comment with a buildall keyword to the Conversation area of the PULL REQUEST, for example: "run buildall cases", git action will detect this behavior and trigger FE single test, BE single test, and code compilation pipeline. when the code compilation pipeline. p0 and p1 pipeline. if you want to execute data lake related use cases simultaneously, You can have a comment like "run buildall and external", and the external pipeline will automatically start the data lake environment to perform the relevant tests.

• When developers find a pipeline running error but want to retry it, they can add a comment with the pipeline keyword in the Conversation area of the PULL REQUEST, such as "run p1". If p1 fails the test due to lack of compilation output, So we need to add a comment with the "run compile" keyword first, and after successful compilation, p0,p1 pipeline will be automatically triggered.

3. How to View Checks

3.1 Github Action

...

• Expected — Waiting for status to be reported: The pipeline is not started, waiting in the queue.
• Pending — TeamCity build started: The pipeline is running.
• TeamCity build finished: The pipeline finished successfully.
• TeamCity build failed: The pipeline finished with errors.
• Skip teamCity build: The pipeline does not need to run and just skiped.

You can click "Details" to go to the TeamCity Web UI. Or visit http://43.132.222.7:8111/login.html directly via web browser.

...

2. At the end of Build Log, you can find a download link to download all FE/BE log and coredump file

5. How to modify the configuration files used in the TeamCity pipelines?

1. the pipeline of P0 Regression (Doris Regression) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/p0/conf
2. the pipeline of P1 Regression (Doris Regression) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/p1/conf
3. the pipeline of External Regression (Doris External Regression) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/external/conf
4. the pipeline of performance (Doris Performance) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/performance/conf
5. the pipeline of cloud_p0 (Doris Cloud Regression) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/cloud_p0/conf
6. the pipeline of cloud_p1 (Doris Cloud Regression) uses the conf in https://github.com/apache/doris/tree/master/regression-test/pipeline/cloud_p1/conf

6. Suggestions

If you have any suggestions and comments, welcome to email dev@doris.apache.org to discuss.

...