e1921fc8c0
### _Why are the changes needed?_ make documentation style to fit official web site ### _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  - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #2751 from yaooqinn/doc2. Closes #2751 b8123525 [Kent Yao] Switch Authored-by: Kent Yao <yao@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
63 lines
2.2 KiB
Markdown
63 lines
2.2 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.
|
|
-->
|
|
|
|
|
|
# Developer Tools
|
|
|
|
## Update Project Version
|
|
|
|
```bash
|
|
|
|
build/mvn versions:set -DgenerateBackupPoms=false
|
|
```
|
|
|
|
## Update Document Version
|
|
|
|
Whenever project version updates, please also update the document version at `docs/conf.py` to target the upcoming release.
|
|
|
|
For example,
|
|
|
|
```python
|
|
release = '1.2.0'
|
|
```
|
|
|
|
## Update Dependency List
|
|
|
|
Kyuubi uses the `dev/dependencyList` file to indicate what upstream dependencies will actually go to the server-side classpath.
|
|
|
|
For Pull requests, a linter for dependency check will be automatically executed in GitHub Actions.
|
|
|
|
You can run `build/dependency.sh` locally first to detect the potential dependency change first.
|
|
|
|
If the changes look expected, run `build/dependency.sh --replace` to update `dev/dependencyList` in your Pull request.
|
|
|
|
|
|
## Format All Code
|
|
|
|
Kyuubi uses [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-maven)
|
|
with [google-java-format](https://github.com/google/google-java-format) and [Scalafmt](https://scalameta.org/scalafmt/)
|
|
to format the Java and Scala code.
|
|
|
|
You can run `dev/reformat` to format all Java and Scala code.
|
|
|
|
|
|
## Append descriptions of new configurations to settings.md
|
|
|
|
Kyuubi uses settings.md to explain available configurations.
|
|
|
|
You can run `KYUUBI_UPDATE=1 build/mvn clean install -Pflink-provided,spark-provided,hive-provided -DwildcardSuites=org.apache.kyuubi.config.AllKyuubiConfiguration`
|
|
to append descriptions of new configurations to settings.md. |