Whats Github Checks

Github checks consists of a series of checking tasks, designed to verify whether the basic functions of doris pass. The main test branch is the pull requests that the developers of the doris open source community synchronize to the doris master branch。Checking tasks are tested separately through 3 pipelines of teamcity: Doris FE UT, Doris BE UT, Doris P0 Regression，and the final test results will be pushed to github.

How to trigger Checks

No manual triggering required. Every commit of every active pull request related to the Doris master branch will be detected by teamcity server after 10 minutes, teamcity automatically generates 3 pipeline tasks (Doris FE UT, Doris BE UT, Doris P0 Regression) related to the commit, waiting for scheduling execution.

Teamcity Pipeline Guidance

Whats Teamcity Server Address

Before you start, you need to know the open source community pipeline address: http://43.132.222.7:8111. Ordinary users can view it as a guest (Log in as guest), or jump directly to the pipeline details page from github.

How to check pipeline results in github

This method is suitable for checking only the build results of a certain pull request

1.  Find the target pull request

Find the target pull request in the git repository of apache/incubator-doris

2. Check teamcity build results in github

On the details page of the target pull request, drop down to the "Review required" section, slide the gray bar on the right, and find the FE UT (Doris FE UT), BE UT (Doris BE UT), and P0 Regression (Doris P0 regression) tasks. A green tick indicates that the build task succeeded, and a red cross indicates that the build task failed. The build result of pull/8901 is shown here

3. Redirect to teamcity to check the specific build task information

Click "Details" on the right side of the construction task, you can jump to teamcity to check the specific information of the build task. The navigation bar of the construction information page contains 5 parts: Overview will give a simple report of task execution; changes will show that the build task involves repository, branch, commit history and other information; Tests will display the result of the case execution. If you want to view the failure details, you can click "Failure" on the left side of the failure case to jump to the specific error information page; the Build log will display The specific log of the task execution, supports retrieval, and supports global log download; Artifacts refers to the content of the task release, but the three pipelines of doris are not involved.

How to check pipeline details in teamcity

This is more appropriate if you want to view the build history of many pull requests

1. Choose "Doris" project

2. Get the specific pull request implementation

2.1  Get the latest execution task of the pull request

Filter the pull request you want to get on the right side of the Doris project, and expand the sub-project to see the latest record details built under the pull request. Green indicates that the build was successfully executed, red indicates that the build task failed, and the reason for the failure is displayed. Taking pull/8901 as an example here, the latest build task of pull/8901 in each subproject is queried in the Doris project. The execution of FE UT fails, and the execution of BE UT and P0 Regression succeeds.

2.2  Get the historical execution tasks of the pull request

If you want to view the historical task records built by the pull request, you can select a branch under each subproject, and you can get the historical records of the branch execution.

3.  Get the details of a specific task

Click the task id to jump to the task details page, and select the information you want to view in the navigation bar. Overview will give a simple report of task execution; changes will show that the build task involves repository, branch, commit history and other information; Tests will display the result of the case execution. If you want to view the failure details, you can click "Failure" on the left side of the failure case to jump to the specific error information page; the Build log will display The specific log of the task execution, supports retrieval, and supports global log download; Artifacts refers to the content of the task release, but the three pipelines of Doris are not involved, ignorable. If you haven't found a build task matching the target branch here, you can continue to step 4.

4. checking pending builds

If the branch construction task has not been found in the previous steps, the target task is still in the queue and has not been scheduled. You can go to "Queue" and use the target pull request to perform a global search to check whether the task is in the queue.

Other questions about Teamcity pipeline

how to re-trigger Teamcity pipeline

1.  Submit a new commit to trigger the pipeline task

After checking the error information of the pipeline, it is confirmed that it is a code problem. You can submit the code to fix the problem and trigger 3 new pipeline build tasks, including FE UT (Doris FE UT), BE UT (Doris BE UT), and P0 Regression (Doris P0 regression) construction tasks.

2. Contact the administrator to re-trigger

If only some of the build tasks fail, and it is confirmed that it is not a code problem, you can contact the administrator and inform the task link that needs to be re-executed. Administrator contact information (****).

Advice on Teamcity pipline

1. If you have a better suggestion for the pipeline, please contact the administrator.
2. If you find a bug in the pipeline, please contact the administrator.
3. If you have new requirements for the pipeline, please contact the administrator.