[build] Generate fluss-xxx-bin.tgz package after build project (#247)

alibaba · Jan 23, 2025 · ee59ca5 · ee59ca5
1 parent 2658ea0
commit ee59ca5
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 1 deletion.
diff --git a/fluss-dist/pom.xml b/fluss-dist/pom.xml
@@ -245,6 +245,18 @@
                             </descriptors>
                         </configuration>
                     </execution>
+                    <execution>
+                        <id>tgz</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                        <configuration>
+                            <descriptors>
+                                <descriptor>src/main/assemblies/tgz.xml</descriptor>
+                            </descriptors>
+                        </configuration>
+                    </execution>
                 </executions>
             </plugin>
         </plugins>

diff --git a/fluss-dist/src/main/assemblies/tgz.xml b/fluss-dist/src/main/assemblies/tgz.xml
@@ -0,0 +1,34 @@
+<!--
+ Copyright (c) 2024 Alibaba Group Holding Ltd.
+
+ Licensed 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.
+-->
+<assembly
+        xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
+    <id>tgz</id>
+    <formats>
+        <format>tgz</format>
+    </formats>
+    <baseDirectory>fluss-${project.version}</baseDirectory>
+    <fileSets>
+        <fileSet>
+            <directory>${project.basedir}/target/fluss-${project.version}-bin/fluss-${project.version}</directory>
+            <outputDirectory>/</outputDirectory>
+            <includes>
+                <include>**/*</include>
+            </includes>
+        </fileSet>
+    </fileSets>
+</assembly>
diff --git a/website/docs/dev/building.md b/website/docs/dev/building.md
@@ -33,4 +33,8 @@ To speed up the build you can:
 The build script will be:
 ```bash
 mvn clean install -DskipTests -T 1C
-```
+```
+
+**NOTE**:
+- For local testing, it's recommend to use directory `${project}/build-target` in project.
+- For deploying distributed cluster, it's recommend to use binary file named `fluss-xxx-bin.tgz`, the file is in directory `${project}/fluss-dist/target`.