5032901dfc
### _Why are the changes needed?_ Guidelines for Document and Code Contributions. - code style - documentation style - quick starts - sphinx-copybutton for copy button in code blocks - add kind:minor,help wanted,good first issue to doc issue template ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1325" alt="image" src="https://user-images.githubusercontent.com/8326978/234193368-473e2a1d-2deb-4d91-901a-19cea58a489b.png"> - [x] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request Closes #4768 from yaooqinn/guide. Closes #4768 3a0bd395b [Kent Yao] Update docs/contributing/doc/build.rst 8fe4f6d14 [Kent Yao] Update docs/contributing/doc/build.rst a753bdde5 [Kent Yao] Guidelines for Document and Code contributions f8393fe8d [Kent Yao] Guidelines for Document and Code contributions 8f2d3ce82 [Kent Yao] Guidelines for Document and Code contributions 4f3a2128b [Kent Yao] Guidelines for Document and Code contributions Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
<!--
|
|
- Licensed to the Apache Software Foundation (ASF) under one or more
|
|
- contributor license agreements. See the NOTICE file distributed with
|
|
- this work for additional information regarding copyright ownership.
|
|
- The ASF licenses this file to You under the Apache License, Version 2.0
|
|
- (the "License"); you may not use this file except in compliance with
|
|
- the License. You may obtain a copy of the License at
|
|
-
|
|
- http://www.apache.org/licenses/LICENSE-2.0
|
|
-
|
|
- Unless required by applicable law or agreed to in writing, software
|
|
- distributed under the License is distributed on an "AS IS" BASIS,
|
|
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
- See the License for the specific language governing permissions and
|
|
- limitations under the License.
|
|
-->
|
|
|
|
# Building From Source
|
|
|
|
## Building With Maven
|
|
|
|
**Kyuubi** is built based on [Apache Maven](https://maven.apache.org),
|
|
|
|
```bash
|
|
./build/mvn clean package -DskipTests
|
|
```
|
|
|
|
This results in the creation of all sub-modules of Kyuubi project without running any unit test.
|
|
|
|
If you want to test it manually, you can start Kyuubi directly from the Kyuubi project root by running
|
|
|
|
```bash
|
|
bin/kyuubi start
|
|
```
|
|
|
|
## Building A Submodule Individually
|
|
|
|
For instance, you can build the Kyuubi Common module using:
|
|
|
|
```bash
|
|
build/mvn clean package -pl kyuubi-common -DskipTests
|
|
```
|
|
|
|
## Building Submodules Individually
|
|
|
|
For instance, you can build the Kyuubi Common module using:
|
|
|
|
```bash
|
|
build/mvn clean package -pl kyuubi-common,kyuubi-ha -DskipTests
|
|
```
|
|
|
|
## Skipping Some Modules
|
|
|
|
For instance, you can build the Kyuubi modules without Kyuubi Codecov and Assembly modules using:
|
|
|
|
```bash
|
|
mvn clean install -pl '!dev/kyuubi-codecov,!kyuubi-assembly' -DskipTests
|
|
```
|
|
|
|
## Building Kyuubi Against Different Apache Spark Versions
|
|
|
|
Since v1.1.0, Kyuubi support building with different Spark profiles,
|
|
|
|
| Profile | Default | Since |
|
|
|-------------|---------|-------|
|
|
| -Pspark-3.1 | No | 1.1.0 |
|
|
| -Pspark-3.2 | No | 1.4.0 |
|
|
| -Pspark-3.3 | Yes | 1.6.0 |
|
|
|
|
## Building With Apache dlcdn Site
|
|
|
|
By default, we use `https://archive.apache.org/dist/` to download the built-in release packages of engines,
|
|
such as Spark or Flink.
|
|
But sometimes, you may find it hard to reach, or the download speed is too slow,
|
|
then you can define the `apache.archive.dist` by `-Pmirror-cdn` to accelerate to download speed.
|
|
For example,
|
|
|
|
```bash
|
|
build/mvn clean package -Pmirror-cdn
|
|
```
|
|
|
|
The profile migrates your download repo to the Apache officially suggested site - https://dlcdn.apache.org.
|
|
Note that, this site only holds the latest versions of Apache releases. You may fail if the specific version
|
|
defined by `spark.version` or `flink.version` is overdue.
|
|
|
|
## Building with the `fast` profile
|
|
|
|
The `fast` profile helps to significantly reduce build time, which is useful for development or compilation validation, by skipping running the tests, code style checks, building scaladoc, enforcer rules and downloading engine archives used for tests.
|
|
|
|
```bash
|
|
build/mvn clean package -Pfast
|
|
```
|
|
|