You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by we...@apache.org on 2022/04/27 03:41:14 UTC
[incubator-seatunnel] branch dev updated: retrieve seatunnel-config form maven (#1754)
This is an automated email from the ASF dual-hosted git repository.
wenjun pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 1060c978 retrieve seatunnel-config form maven (#1754)
1060c978 is described below
commit 1060c978a68c94e7dc48312f5a79b0af6d7ef0c8
Author: Wenjun Ruan <we...@apache.org>
AuthorDate: Wed Apr 27 11:41:09 2022 +0800
retrieve seatunnel-config form maven (#1754)
---
pom.xml | 12 +++++++++++-
seatunnel-apis/seatunnel-api-base/pom.xml | 1 -
seatunnel-apis/seatunnel-api-flink/pom.xml | 1 -
seatunnel-common/pom.xml | 2 --
seatunnel-config/README.md | 25 +++++++++++++++++++++++++
tools/dependencies/known-dependencies.txt | 2 ++
6 files changed, 38 insertions(+), 5 deletions(-)
diff --git a/pom.xml b/pom.xml
index a1cce8f0..ba03cb21 100644
--- a/pom.xml
+++ b/pom.xml
@@ -72,7 +72,11 @@
</mailingLists>
<modules>
- <module>seatunnel-config</module>
+ <!--
+ We retrieve the config module from maven repository. If you want to change the config module,
+ you need to open this annotation and change the dependency of config-shade to project.
+ <module>seatunnel-config</module>
+ -->
<module>seatunnel-common</module>
<module>seatunnel-apis</module>
<module>seatunnel-core</module>
@@ -85,6 +89,7 @@
<properties>
<revision>2.1.1-SNAPSHOT</revision>
+ <seatunnel.config.shade.version>2.1.1</seatunnel.config.shade.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
<scala.version>2.11.12</scala.version>
@@ -168,6 +173,11 @@
<dependencyManagement>
<dependencies>
+ <dependency>
+ <groupId>org.apache.seatunnel</groupId>
+ <artifactId>seatunnel-config-shade</artifactId>
+ <version>${seatunnel.config.shade.version}</version>
+ </dependency>
<!--spark-->
<dependency>
<groupId>org.apache.spark</groupId>
diff --git a/seatunnel-apis/seatunnel-api-base/pom.xml b/seatunnel-apis/seatunnel-api-base/pom.xml
index 458133cf..9fe32871 100644
--- a/seatunnel-apis/seatunnel-api-base/pom.xml
+++ b/seatunnel-apis/seatunnel-api-base/pom.xml
@@ -39,7 +39,6 @@
<dependency>
<groupId>org.apache.seatunnel</groupId>
<artifactId>seatunnel-config-shade</artifactId>
- <version>${project.version}</version>
</dependency>
</dependencies>
diff --git a/seatunnel-apis/seatunnel-api-flink/pom.xml b/seatunnel-apis/seatunnel-api-flink/pom.xml
index 6126ebaa..739b52ec 100644
--- a/seatunnel-apis/seatunnel-api-flink/pom.xml
+++ b/seatunnel-apis/seatunnel-api-flink/pom.xml
@@ -89,5 +89,4 @@
</dependencies>
-
</project>
diff --git a/seatunnel-common/pom.xml b/seatunnel-common/pom.xml
index e35a9075..c6033308 100644
--- a/seatunnel-common/pom.xml
+++ b/seatunnel-common/pom.xml
@@ -32,7 +32,6 @@
<dependency>
<groupId>org.apache.seatunnel</groupId>
<artifactId>seatunnel-config-shade</artifactId>
- <version>${project.version}</version>
</dependency>
<dependency>
@@ -56,5 +55,4 @@
</dependency>
</dependencies>
-
</project>
diff --git a/seatunnel-config/README.md b/seatunnel-config/README.md
new file mode 100644
index 00000000..4932a3f2
--- /dev/null
+++ b/seatunnel-config/README.md
@@ -0,0 +1,25 @@
+# Introduction
+The `seatunnel-config` is used to parse `seatunnel.conf` files. This module is based on `com.typesafe.config`,
+We have made some enhancement and import our enhancement by using maven shade. Most of the times, you don't need to directly
+using this module, since you can receive from maven repository.
+
+# How to modify the config module
+If you want to modify the config module, you can follow the steps below.
+1. Open the `seatunnel-config` module.
+```xml
+<!--
+ We retrieve the config module from maven repository. If you want to change the config module,
+ you need to open this annotation and change the dependency of config-shade to project.
+ <module>seatunnel-config</module>
+-->
+```
+Open the annuotaion in `pom.xml` file, to import the `seatunnel-config` module.
+2. Replace the `config-shade` dependency to project.
+```xml
+<dependency>
+ <groupId>org.apache.seatunnel</groupId>
+ <artifactId>seatunnel-config-shade</artifactId>
+ <version>${project.version}</version>
+</dependency>
+```
+Add `<version>${project.version}</version>` to `seatunnel-config-shade` everywhere you use.
\ No newline at end of file
diff --git a/tools/dependencies/known-dependencies.txt b/tools/dependencies/known-dependencies.txt
index 32699e2a..9c1b0246 100755
--- a/tools/dependencies/known-dependencies.txt
+++ b/tools/dependencies/known-dependencies.txt
@@ -584,6 +584,8 @@ scala-xml_2.11-1.0.5.jar
scala-xml_2.11-1.3.0.jar
scalaj-http_2.11-2.3.0.jar
scalap-2.11.12.jar
+seatunnel-config-base-2.1.1.jar
+seatunnel-config-shade-2.1.1.jar
servlet-api-2.5.jar
shims-0.9.0.jar
shims-0.9.22.jar