### _Why are the changes needed?_ Add Docs for kyuubi tools spark-block-cleaner. * Explain the parameters * Introduction to basic startup * Give an example ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [ ] Add screenshots for manual tests if appropriate - [X] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request Closes #815 from zwangsheng/doc/spark_block_cleaner. Closes #815 1ec6795f [Binjie Yang] delete todo bbf4d6e2 [Binjie Yang] make it common 9cf3e159 [Binjie Yang] format 0803995a [Binjie Yang] straighten out the article f834b382 [Binjie Yang] refactor 25be318f [Binjie Yang] fix 7304e595 [Binjie Yang] docs for spark-block-cleaner Authored-by: Binjie Yang <2213335496@qq.com> Signed-off-by: ulysses-you <ulyssesyou18@gmail.com>
36 lines
843 B
Markdown
36 lines
843 B
Markdown
<div align=center>
|
|
|
|

|
|
|
|
</div>
|
|
|
|
# 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 indicates 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.
|