Project: ClickHouse (App Definition and Development / Database)
File: continuous-integration.md

slug: /en/development/continuous-integration sidebar_position: 62 sidebar_label: Continuous Integration Checks title: Continuous Integration Checks description: When you submit a pull request, some automated checks are ran for your code by the ClickHouse continuous integration (CI) system When you submit a pull request, some automated checks are ran for your code by the ClickHouse . This happens after a repository maintainer (someone from ClickHouse team) has screened your code and added the `can be tested` label to your pull request. The results of the checks are listed on the GitHub pull request page as described in the [GitHub checks documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-status-checks). If a check is failing, you might be required to fix it. This page gives an overview of checks you may encounter, and what you can do to fix them. If it looks like the check failure is not related to your changes, it may be some transient failure or an infrastructure problem. Push an empty commit to the pull request to restart the CI checks: ``` git reset git commit --allow-empty git push ``` If you are not sure what to do, ask a maintainer for help. Verifies that the PR can be merged to master. If not, it will fail with the message `Cannot fetch mergecommit`. To fix this check, resolve the conflict as described in the [GitHub documentation](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github), or merge the `master` branch to your pull request branch using git. Tries to build the ClickHouse documentation website. It can fail if you changed something in the documentation. Most probable reason is that some cross-link in the documentation is wrong. Go to the check report and look for `ERROR` and `WARNING` messages. Check that the description of your pull request conforms to the template . You have to specify a changelog category for your change (e.g., Bug Fix), and write a user-readable message describing the change for Builds docker images used for build and tests, then pushes them to DockerHub. This check means that the CI system started to process the pull request. When it has 'pending' status, it means that not all checks have been started yet. After all checks have been started, it changes status to 'success'. Performs some simple regex-based checks of code style, using the binary (note that it can be run locally). If it fails, fix the style errors following the . ```sh mkdir -p /tmp/test_output docker run --rm --volume=.:/ClickHouse --volume=/tmp/testoutput:/testoutput -u $(id -u ${USER}):$(id -g ${USER}) --cap-add=SYS_PTRACE clickhouse/style-test docker run --rm --volume=.:/ClickHouse --volume=/tmp/testoutput:/testoutput -u $(id -u ${USER}):$(id -g ${USER}) --cap-add=SYS_PTRACE --entrypoint= -w/ClickHouse/utils/check-style clickhouse/style-test ./check-mypy cd ./utils/check-style ./check-duplicate-includes.sh ./check-style ./check-black ./check-mypy ./check-typos ./check-doc-aspell ./check-whitespaces ./check-workflows ./check-submodules ./shellcheck-run.sh ``` Normally this is the first check that is ran for a PR. It builds ClickHouse and runs most of , omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described

```sh mkdir -p /tmp/test_output mkdir -p /tmp/fasttest-workspace cd ClickHouse docker run --rm --cap-add=SYSPTRACE -u $(id -u ${USER}):$(id -g ${USER}) --network=host -e FASTTESTWORKSPACE=/fasttest-workspace -e FASTTESTOUTPUT=/testoutput -e FASTTESTSOURCE=/ClickHouse --cap-add=SYSPTRACE -e stage=clonesubmodules --volume=/tmp/fasttest-workspace:/fasttest-workspace --volume=.:/ClickHouse --volume=/tmp/testoutput:/test_output clickhouse/fasttest ``` `runlog.out.log` is the general log that includes all other logs. `test_log.txt` `submodule_log.txt` contains the messages about cloning and checkouting needed submodules. `stderr.log` `stdout.log` `clickhouse-server.log` `clone_log.txt` `install_log.txt` `clickhouse-server.err.log` `build_log.txt` `cmake_log.txt` contains messages about the C/C++ and Linux flags check. Test name contains the name of the test (without the path e.g. all types of tests will be stripped to the name). Test status -- one of Skipped, Success, or Fail. Test time, sec. -- empty on this test. Builds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The `cmake` options can be found in the build log, grepping for `cmake`. Use these options and follow the . Compiler: `clang-18`, optionally with the name of a target platform Build type: `Debug` or `RelWithDebInfo` (cmake). Sanitizer: `none` (without sanitizers), `address` (ASan), `memory` (MSan), `undefined` (UBSan), or `thread` (TSan). Status: `success` or `fail` Build log: link to the building and files copying log, useful when build failed. Build time. Artifacts: build result files (with `XXX` being the server version e.g. `20.8.1.4344`). `clickhouse-clientXXXamd64.deb` `clickhouse-common-static-dbgXXX[+asan, +msan, +ubsan, +tsan]amd64.deb` `clickhouse-common-staticXXX_amd64.deb` `clickhouse-serverXXXamd64.deb` `clickhouse`: Main built binary. `clickhouse-odbc-bridge` `unittestsdbms`: GoogleTest binary with ClickHouse unit tests. `performance.tar.zst`: Special package for performance tests. Performs static analysis and code style checks using `clang-tidy`. The report is similar to the . Fix the errors found in the build log. There is a convenience `packager` script that runs the clang-tidy build in docker ```sh mkdir build_tidy ./docker/packager/packager --output-dir=./build_tidy --package-type=binary --compiler=clang-18 --debug-build --clang-tidy ``` Runs for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc. Look at the report to see which tests fail, then reproduce the failure locally as described . Note that you have to use the correct build configuration to reproduce -- a test might fail under AddressSanitizer but pass in Debug. Download the binary from [CI build checks page](../development/build.md#you-dont-have-to-build-clickhouse), or build it locally. Runs . Treat them in the same way as the functional stateless tests. The difference is that they require `hits` and `visits` tables from the to run. Runs . Checks that either a new test (functional or integration) or there some changed tests that fail with the binary built on master branch. This check is triggered when pull request has "pr-bugfix" label. Runs stateless functional tests concurrently from several clients to detect concurrency-related errors. If it fails: Fix all other test failures first; Look at the report to find the server logs and check them for possible causes of error. Checks that `clickhouse` binary runs on distributions with old libc versions. If it fails, ask a maintainer for help. Runs randomly generated queries to catch program errors. If it fails, ask a maintainer for help. Measure changes in query performance. This is the longest check that takes just below 6 hours to run. The performance test report is described in detail .