kyuubi/docs/develop_tools/distribution.md
Cheng Pan 20394398c0
[KYUUBI #889] [BUILD] Package release tarball
<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
```
export RELEASE_VERSION=1.3.0-SNAPSHOT # keep same version with pom.xml
export SKIP_GPG=false                 # optional, default false
build/release/create-package.sh source
build/release/create-package.sh binary
```
```
➜  apache-kyuubi git:(asf-pub) ls -lh work/release
total 161256
-rw-r--r--  1 chengpan  staff    60M Aug  4 15:12 kyuubi-1.3.0-SNAPSHOT-bin.tgz
-rw-r--r--  1 chengpan  staff   488B Aug  4 15:12 kyuubi-1.3.0-SNAPSHOT-bin.tgz.asc
-rw-r--r--  1 chengpan  staff   212B Aug  4 15:12 kyuubi-1.3.0-SNAPSHOT-bin.tgz.sha512
-rw-r--r--  1 chengpan  staff    18M Aug  4 15:10 kyuubi-1.3.0-SNAPSHOT-source.tgz
-rw-r--r--  1 chengpan  staff   488B Aug  4 15:10 kyuubi-1.3.0-SNAPSHOT-source.tgz.asc
-rw-r--r--  1 chengpan  staff   215B Aug  4 15:10 kyuubi-1.3.0-SNAPSHOT-source.tgz.sha512
```

Planning to add release script and release doc in following PRs.

### _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

- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/tools/testing.html#running-tests) locally before make a pull request

Closes #889 from pan3793/asf-package.

Closes #889

0aef5d77 [Cheng Pan] Update docs
4b0be7da [Cheng Pan] [BUILD] Package release tarball

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2021-08-06 13:17:51 +08:00

1.3 KiB

Building a Runnable Distribution

To create a Kyuubi distribution like those distributed by Kyuubi Release Page, and that is laid out so as to be runnable, use ./build/dist in the project root directory.

For more information on usage, run ./build/dist --help

./build/dist - Tool for making binary distributions of Kyuubi Server

Usage:
+--------------------------------------------------------------------------------------+
| ./build/dist [--name <custom_name>] [--tgz] [--spark-provided] <maven build options> |
+--------------------------------------------------------------------------------------+
name:           -  custom binary name, using project version if undefined
tgz:            -  whether to make a whole bundled package
spark-provided: -  whether to make a package without Spark binary

For instance,

./build/dist --name custom-name --tgz

This results a Kyuubi distribution named kyuubi-{version}-bin-custom-name.tgz for you.

If you are planing to deploy Kyuubi where spark is provided, in other word, it's not required to bundle spark binary, use

./build/dist --tgz --spark-provided

Then you will get a Kyuubi distribution without spark binary named kyuubi-{version}-bin.tgz.