Skip to content

Add documentation for building in docker#51679

Merged
Felixoid merged 2 commits intomasterfrom
docs-packaging
Jul 3, 2023
Merged

Add documentation for building in docker#51679
Felixoid merged 2 commits intomasterfrom
docs-packaging

Conversation

@Felixoid
Copy link
Copy Markdown
Member

@Felixoid Felixoid commented Jun 30, 2023

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Finally, document the replacement for ./release after #36330

@Felixoid Felixoid mentioned this pull request Jun 30, 2023
Closed
17 tasks
@robot-ch-test-poll1 robot-ch-test-poll1 added the pr-documentation Documentation PRs for the specific code PR label Jun 30, 2023
@robot-ch-test-poll1
Copy link
Copy Markdown
Contributor

robot-ch-test-poll1 commented Jun 30, 2023 •
edited by robot-ch-test-poll3
Loading

This is an automated comment for commit c715ee5 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🟢 success

Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help🟢 success
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR🟢 success
ClickHouse build checkBuilds 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 general build process🟢 success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help🟢 success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub🟢 success
Docs CheckBuilds and tests the documentation🟢 success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, 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 here🟢 success
Install packagesChecks that the built packages are installable in a clear environment🟢 success
Mergeable CheckChecks if all other necessary checks are successful🟢 success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests🟢 success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool🟢 success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report🟢 success
Unit testsRuns the unit tests for different release types🟢 success

@Felixoid Felixoid marked this pull request as draft June 30, 2023 13:28
@Felixoid Felixoid force-pushed the docs-packaging branch 2 times, most recently from f4034d8 to 469da18 Compare July 3, 2023 15:42
@Felixoid Felixoid marked this pull request as ready for review July 3, 2023 15:47
@vdimir vdimir self-assigned this Jul 3, 2023
vdimir
vdimir approved these changes Jul 3, 2023
View reviewed changes
@Felixoid Felixoid mentioned this pull request Jul 3, 2023
Merged
@Felixoid Felixoid merged commit 4d76b53 into master Jul 3, 2023
@Felixoid Felixoid deleted the docs-packaging branch July 3, 2023 19:46
antonio2368
antonio2368 reviewed Jul 4, 2023
View reviewed changes
docker/packager/packager
if build_type:
result.append(f"BUILD_TYPE={build_type.capitalize()}")
if debug_build:
result.append("BUILD_TYPE=DEBUG")
Copy link
Copy Markdown
Member

@antonio2368 antonio2368 Jul 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

put my comment in commit by accident
This breaks tests because in clickhouse-test we check for Debug when processing tags so we don't skip tests when we should
Can we make this Debug?

Copy link
Copy Markdown
Member Author

@Felixoid Felixoid Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, it must be Debug

In [1]: "debug".capitalize()
Out[1]: 'Debug'

I misinterpreted capitalize and upper

@alexey-milovidov
Copy link
Copy Markdown
Member

alexey-milovidov commented Jul 4, 2023

@vdimir this was merged without tests, and apparently, the tests are broken after this PR:

Screenshot_20230704_130553

@alexey-milovidov alexey-milovidov mentioned this pull request Jul 4, 2023
Merged
@antonio2368 antonio2368 mentioned this pull request Jul 4, 2023
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@antonio2368 antonio2368 antonio2368 left review comments

@vdimir vdimir vdimir approved these changes

Assignees

@vdimir vdimir

Labels

pr-documentation Documentation PRs for the specific code PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Felixoid @robot-ch-test-poll1 @alexey-milovidov @vdimir @antonio2368