74e52f6924
### _Why are the changes needed?_ - Update the regeneration hits for `setting.md` in `develop.md`, as the config doc`settings.md` is checked and able to regenearted by `dev/gen/gen_all_config_docs.sh` script. ### _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/master/contributing/code/testing.html#running-tests) locally before make a pull request ### _Was this patch authored or co-authored using generative AI tooling?_ No. Closes #5409 from bowenliang123/regen-settings. Closes #5409 985f39e51 [Bowen Liang] update docs Authored-by: Bowen Liang <liangbowen@gf.com.cn> Signed-off-by: Bowen Liang <liangbowen@gf.com.cn>
59 lines
2.5 KiB
Markdown
59 lines
2.5 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 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 `dev/gen/gen_all_config_docs.sh` to append and update descriptions of new configurations to `settings.md`.
|
|
|
|
## Generative Tooling Usage
|
|
|
|
In general, the ASF allows contributions co-authored using generative AI tools. However, there are several considerations when you submit a patch containing generated content.
|
|
|
|
Foremost, you are required to disclose usage of such tool. Furthermore, you are responsible for ensuring that the terms and conditions of the tool in question are
|
|
compatible with usage in an Open Source project and inclusion of the generated content doesn't pose a risk of copyright violation.
|
|
|
|
Please refer to [The ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for more detailed information.
|