This is an automated email from the ASF dual-hosted git repository.
zhaojinchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 3f9f373cda5 Fix : fix the deadlink (#28369)
3f9f373cda5 is described below
commit 3f9f373cda5e91ca08e68c2c5f2f14edf6a74f5f
Author: 孙念君 Nianjun Sun <[email protected]>
AuthorDate: Wed Sep 6 12:20:30 2023 +0800
Fix : fix the deadlink (#28369)
---
.github/workflows/nightly-build.yml | 8 ++++----
...\200\231s_Template_Engine_for_Streamlined_Examples.en.md" | 12 ++++++------
examples/README.md | 4 ++--
examples/README_ZH.md | 6 +++---
.../src/main/resources/logback.xml | 2 +-
5 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/.github/workflows/nightly-build.yml
b/.github/workflows/nightly-build.yml
index c056944e8d9..2d1883578eb 100644
--- a/.github/workflows/nightly-build.yml
+++ b/.github/workflows/nightly-build.yml
@@ -222,17 +222,17 @@ jobs:
- name: Build with Maven
run: ./mvnw -B -T1C -ntp clean install -DskipITs -DskipTests
- name: Generate Examples
- run: ./mvnw -B clean install -f
examples/shardingsphere-example-generator/pom.xml -Pexample-generator
-Dproducts=${{ matrix.product }} -Dmodes=${{ matrix.mode }} -Dtransactions=${{
matrix.transaction }} -Dfeatures=${{ matrix.feature }} -Dframeworks=${{
matrix.framework }}
+ run: ./mvnw -B clean install -f
examples/shardingsphere-jdbc-example-generator/pom.xml -Pexample-generator
-Dproducts=${{ matrix.product }} -Dmodes=${{ matrix.mode }} -Dtransactions=${{
matrix.transaction }} -Dfeatures=${{ matrix.feature }} -Dframeworks=${{
matrix.framework }}
- name: Test Examples
- run : ./mvnw -B test -f
examples/shardingsphere-example-generator/target/generated-sources/shardingsphere-jdbc-sample/${{
matrix.feature }}--${{ matrix.framework }}--${{ matrix.mode }}--${{
matrix.transaction }}/pom.xml -Pexample-generator
-Dexec.cleanupDaemonThreads=false
+ run : ./mvnw -B test -f
examples/shardingsphere-jdbc-example-generator/target/generated-sources/shardingsphere-jdbc-sample/${{
matrix.feature }}--${{ matrix.framework }}--${{ matrix.mode }}--${{
matrix.transaction }}/pom.xml -Pexample-generator
-Dexec.cleanupDaemonThreads=false
- name: Package Examples
run: |
- cd
examples/shardingsphere-example-generator/target/generated-sources/shardingsphere-jdbc-sample/
+ cd
examples/shardingsphere-jdbc-example-generator/target/generated-sources/shardingsphere-jdbc-sample/
tar -czvf ${{ matrix.feature }}--${{ matrix.framework }}--${{
matrix.mode }}--${{ matrix.transaction }}.tar.gz ${{ matrix.feature }}--${{
matrix.framework }}--${{ matrix.mode }}--${{ matrix.transaction }}
- uses: burnett01/[email protected]
with:
switches: -avzr
- path:
examples/shardingsphere-example-generator/target/generated-sources/shardingsphere-jdbc-sample/${{
matrix.feature }}--${{ matrix.framework }}--${{ matrix.mode }}--${{
matrix.transaction }}.tar.gz
+ path:
examples/shardingsphere-jdbc-example-generator/target/generated-sources/shardingsphere-jdbc-sample/${{
matrix.feature }}--${{ matrix.framework }}--${{ matrix.mode }}--${{
matrix.transaction }}.tar.gz
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH
}}/shardingsphere/examples
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
diff --git
"a/docs/blog/content/material/2023_05_10_Simplifying_Learning_ShardingSphere\342\200\231s_Template_Engine_for_Streamlined_Examples.en.md"
"b/docs/blog/content/material/2023_05_10_Simplifying_Learning_ShardingSphere\342\200\231s_Template_Engine_for_Streamlined_Examples.en.md"
index bfd8c02d517..18d9db030c7 100644
---
"a/docs/blog/content/material/2023_05_10_Simplifying_Learning_ShardingSphere\342\200\231s_Template_Engine_for_Streamlined_Examples.en.md"
+++
"b/docs/blog/content/material/2023_05_10_Simplifying_Learning_ShardingSphere\342\200\231s_Template_Engine_for_Streamlined_Examples.en.md"
@@ -89,14 +89,14 @@ Each module generated within this framework is a standalone
project, allowing fo
## 1. Locate the Example Generation Module
-Navigate to the [ShardingSphere project
directory](https://github.com/apache/shardingsphere) and find the
`shardingsphere-example-generator` module within the corresponding example
module. This module contains all the template files and generation logic
required for generating examples.
+Navigate to the [ShardingSphere project
directory](https://github.com/apache/shardingsphere) and find the
`shardingsphere-jdbc-example-generator` module within the corresponding example
module. This module contains all the template files and generation logic
required for generating examples.
Figure
5 — Project structure of the generation engine
## 2. Configure the Generation Engine Parameters
-The `shardingsphere-example-generator` module is a standard Java project. The
project's configuration file can be found at `resources/config.yaml`. This file
allows users to declare various parameters supported by the generation engine.
In addition to the template parameters for specific functions, we have also
provided convenient configurations that users can customize according to their
needs. The specific parameters and their meanings are outlined in Table 2:
+The `shardingsphere-jdbc-example-generator` module is a standard Java project.
The project's configuration file can be found at `resources/config.yaml`. This
file allows users to declare various parameters supported by the generation
engine. In addition to the template parameters for specific functions, we have
also provided convenient configurations that users can customize according to
their needs. The specific parameters and their meanings are outlined in Table 2:
@@ -104,21 +104,21 @@ The `shardingsphere-example-generator` module is a
standard Java project. The pr
After configuring the parameters, it’s time to generate the corresponding
configuration module. This can be done in two ways:
-- **Running the Main Class:** Locate the `ExampleGeneratorMain` class under
the `shardingsphere-example-generator` module and run the main method. This
will generate the example in the configured output directory.
+- **Running the Main Class:** Locate the `ExampleGeneratorMain` class under
the `shardingsphere-jdbc-example-generator` module and run the main method.
This will generate the example in the configured output directory.
- **Using Maven Command Line:** Alternatively, you can use the Maven command
line to trigger the generation process. The command should be executed as
follows:
```
// generate configuration based on config.yaml
-./mvnw -B clean install -f examples/shardingsphere-example-generator/pom.xml
-Pexample-generator
+./mvnw -B clean install -f
examples/shardingsphere-jdbc-example-generator/pom.xml -Pexample-generator
// generation configuration based on command parameters
-./mvnw -B clean install -f examples/shardingsphere-example-generator/pom.xml
-Pexample-generator -Dproducts=jdbc -Dmodes=cluster-zookeeper
-Dtransactions=local -Dfeatures=shadow -Dframeworks=jdbc
+./mvnw -B clean install -f
examples/shardingsphere-jdbc-example-generator/pom.xml -Pexample-generator
-Dproducts=jdbc -Dmodes=cluster-zookeeper -Dtransactions=local
-Dfeatures=shadow -Dframeworks=jdbc
```
## 4. View and Utilize the Examples
-Once the generation process is triggered, the associated example code will be
generated in the configured output directory. Typically, this would be in the
`shardingsphere-example-generator/target/generated-sources/ directory`. The
generated directory structure can be seen in Figure 6 below:
+Once the generation process is triggered, the associated example code will be
generated in the configured output directory. Typically, this would be in the
`shardingsphere-jdbc-example-generator/target/generated-sources/ directory`.
The generated directory structure can be seen in Figure 6 below:
Figure
6 — Directory structure for generating examples
diff --git a/examples/README.md b/examples/README.md
index 1b40916951a..6d1fa83bf5b 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -40,7 +40,7 @@ shardingsphere-example
│ ├── example-raw-jdbc
│ ├── example-spring-jpa
│ └── example-spring-mybatis
- ├── shardingsphere-example-generator
+ ├── shardingsphere-jdbc-example-generator
├── shardingsphere-parser-example
├── shardingsphere-proxy-example
│ ├── shardingsphere-proxy-boot-mybatis-example
@@ -54,7 +54,7 @@ shardingsphere-example
| Example
| Description
|
|------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
-| [ShardingSphere-JDBC Examples](shardingsphere-example-generator/README.md)
| Generate the examples by configuration and show how to use
ShardingSphere-JDBC |
+| [ShardingSphere-JDBC
Examples](shardingsphere-jdbc-example-generator/README.md) | Generate the
examples by configuration and show how to use ShardingSphere-JDBC |
| [DistSQL](shardingsphere-proxy-example/shardingsphere-proxy-distsql-example)
| show how to use DistSQL in ShardingSphere-Proxy
|
| APM(Pending)
| show how to use APM in ShardingSphere
|
| proxy(Pending)
| show how to use ShardingSphere-Proxy
|
diff --git a/examples/README_ZH.md b/examples/README_ZH.md
index 0589f2529d5..a2f67be83d3 100644
--- a/examples/README_ZH.md
+++ b/examples/README_ZH.md
@@ -6,7 +6,7 @@
**注意事项**
-- *`shardingsphere-example-generator`模块是一个全新的示例体验模块*
+- *`shardingsphere-jdbc-example-generator`模块是一个全新的示例体验模块*
-
*如果采用手动模式，请在首次运行示例之前执行[初始化脚本](https://github.com/apache/shardingsphere/blob/master/examples/src/resources/manual_schema.sql)。*
@@ -41,7 +41,7 @@ shardingsphere-example
│ ├── example-raw-jdbc
│ ├── example-spring-jpa
│ └── example-spring-mybatis
- ├── shardingsphere-example-generator
+ ├── shardingsphere-jdbc-example-generator
├── shardingsphere-parser-example
├── shardingsphere-proxy-example
│ ├── shardingsphere-proxy-boot-mybatis-example
@@ -55,7 +55,7 @@ shardingsphere-example
| 例子
| 描述 |
|------------------------------------------------------------------------------|--------------------------------------|
-| [ShardingSphere-JDBC示例](shardingsphere-example-generator/README_ZH.md)
| 通过配置生成ShardingSphere-JDBC的演示示例 |
+| [ShardingSphere-JDBC示例](shardingsphere-jdbc-example-generator/README_ZH.md)
| 通过配置生成ShardingSphere-JDBC的演示示例 |
| [DistSQL](shardingsphere-proxy-example/shardingsphere-proxy-distsql-example)
| 演示在 ShardingSphere-Proxy 中使用 DistSQL |
| APM 监控(Pending)
| 演示在 ShardingSphere 中使用 APM 监控 |
| proxy(Pending)
| 演示使用 ShardingSphere-Proxy |
diff --git
a/examples/shardingsphere-jdbc-example-generator/src/main/resources/logback.xml
b/examples/shardingsphere-jdbc-example-generator/src/main/resources/logback.xml
index 2c9638ba476..0dbb297e5f2 100644
---
a/examples/shardingsphere-jdbc-example-generator/src/main/resources/logback.xml
+++
b/examples/shardingsphere-jdbc-example-generator/src/main/resources/logback.xml
@@ -17,7 +17,7 @@
-->
<configuration>
- <property name="log.context.name" value="shardingsphere-example-generator"
/>
+ <property name="log.context.name"
value="shardingsphere-jdbc-example-generator" />
<property name="log.charset" value="UTF-8" />
<property name="log.pattern" value="%msg %n" />
<contextName>${log.context.name}</contextName>
