This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/apisix-java-plugin-runner.git
The following commit(s) were added to refs/heads/main by this push:
new b862026 docs: add Markfile and Changelog.md (#35)
b862026 is described below
commit b8620260236fdd3756c9e4725a71dde4f6246d3b
Author: tzssangglass <[email protected]>
AuthorDate: Fri Jun 25 10:15:40 2021 +0800
docs: add Markfile and Changelog.md (#35)
---
CHANGELOG.md | 44 +++++++++++
Makefile | 36 +++++++++
.../the-internal-of-apisix-java-plugin-runner.png | Bin 58191 -> 74686 bytes
runner-dist/{ => apisix-runner-bin-dist}/pom.xml | 16 +---
.../src/main/assembly/assemble.xml | 9 +--
.../src/main/bin/shutdown.sh | 0
.../src/main/bin/startup.sh | 0
runner-dist/{ => apisix-runner-src-dist}/pom.xml | 23 ++----
.../src/main/assembly/assemble.xml | 87 +++++++++++++++++++++
runner-dist/pom.xml | 50 ++----------
10 files changed, 184 insertions(+), 81 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..b24ae15
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,44 @@
+---
+title: Changelog
+---
+
+<!--
+#
+# 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.
+#
+-->
+
+## Table of Contents
+
+- [0.1.0](#010)
+
+## 0.1.0
+
+This release mainly provides basic features and adds test cases.
+
+### Core
+
+- complete project skeleton and available features.
+- complete united test with [APISIX](https://github.com/apache/apisix).
+- supported debug mode.
+
+## Bugfix
+
+- set more headers and args.
[#30](https://github.com/apache/apisix-java-plugin-runner/pull/30)
+- ensure correct encoding and decoding when data length is greater than 256.
[#32](https://github.com/apache/apisix-java-plugin-runner/pull/32)
+- use netty's decoder to handle TCP half-packet issues that occur in custom
protocols. [#26](https://github.com/apache/apisix-java-plugin-runner/pull/26)
+
+[Back to TOC](#table-of-contents)
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..1bf7a5c
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,36 @@
+#
+# 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.
+#
+
+SHELL := /bin/bash -o pipefail
+
+VERSION ?= 0.1.0-SNAPSHOT
+RELEASE_SRC = apache-apisix-java-plugin-runner-${VERSION}-src
+
+.PHONY: release-src
+release-src: compress-tar
+ gpg --batch --yes --armor --detach-sig ./dist/$(RELEASE_SRC).tgz
+ shasum -a 512 ./dist/$(RELEASE_SRC).tgz >
./dist/$(RELEASE_SRC).tgz.sha512
+
+ mkdir -p release
+ mv ./dist/$(RELEASE_SRC).tgz release/$(RELEASE_SRC).tgz
+ mv ./dist/$(RELEASE_SRC).tgz.asc release/$(RELEASE_SRC).tgz.asc
+ mv ./dist/$(RELEASE_SRC).tgz.sha512 release/$(RELEASE_SRC).tgz.sha512
+
+.PHONY: compress-tar
+compress-tar:
+ ./mvnw package
+
diff --git a/docs/assets/images/the-internal-of-apisix-java-plugin-runner.png
b/docs/assets/images/the-internal-of-apisix-java-plugin-runner.png
index 458e8a3..c54d476 100644
Binary files a/docs/assets/images/the-internal-of-apisix-java-plugin-runner.png
and b/docs/assets/images/the-internal-of-apisix-java-plugin-runner.png differ
diff --git a/runner-dist/pom.xml b/runner-dist/apisix-runner-bin-dist/pom.xml
similarity index 86%
copy from runner-dist/pom.xml
copy to runner-dist/apisix-runner-bin-dist/pom.xml
index 9b879f7..77069bd 100644
--- a/runner-dist/pom.xml
+++ b/runner-dist/apisix-runner-bin-dist/pom.xml
@@ -22,22 +22,14 @@
<parent>
<groupId>org.apache.apisix</groupId>
- <artifactId>apisix-plugin-runner</artifactId>
+ <artifactId>apisix-runner-dist</artifactId>
<version>0.1.0-SNAPSHOT</version>
</parent>
- <artifactId>apisix-runner-dist</artifactId>
+ <artifactId>apisix-runner-bin-dist</artifactId>
<packaging>jar</packaging>
- <name>APISIX Java Plugin Runner Distribution</name>
-
- <dependencies>
- <dependency>
- <groupId>org.apache.apisix</groupId>
- <artifactId>apisix-runner-starter</artifactId>
- <version>0.1.0-SNAPSHOT</version>
- </dependency>
- </dependencies>
+ <name>${project.artifactId}</name>
<build>
<finalName>apisix-runner-bin</finalName>
@@ -73,7 +65,7 @@
<configuration>
<target>
<copy
file="${project.build.directory}/apisix-runner-bin.tar.gz"
-
tofile="${project.basedir}/../dist/apache-apisix-runner-bin.tar.gz"
+
tofile="${project.basedir}/../../dist/aapache-apisix-java-plugin-runner-${project.version}-bin.tar.gz"
overwrite="true" />
</target>
</configuration>
diff --git a/runner-dist/src/main/assembly/assemble.xml
b/runner-dist/apisix-runner-bin-dist/src/main/assembly/assemble.xml
similarity index 87%
rename from runner-dist/src/main/assembly/assemble.xml
rename to runner-dist/apisix-runner-bin-dist/src/main/assembly/assemble.xml
index cd78424..ec46a6e 100644
--- a/runner-dist/src/main/assembly/assemble.xml
+++ b/runner-dist/apisix-runner-bin-dist/src/main/assembly/assemble.xml
@@ -30,18 +30,11 @@
<directory>${project.basedir}/..</directory>
<outputDirectory>/</outputDirectory>
<includes>
- <include>README*</include>
+ <include>*.md</include>
<include>LICENSE*</include>
<include>NOTICE*</include>
</includes>
</fileSet>
- <fileSet>
- <directory>${project.basedir}/src/main/bin</directory>
- <outputDirectory>/bin</outputDirectory>
- <includes>
- <include>*.sh</include>
- </includes>
- </fileSet>
</fileSets>
<moduleSets>
<moduleSet>
diff --git a/runner-dist/src/main/bin/shutdown.sh
b/runner-dist/apisix-runner-bin-dist/src/main/bin/shutdown.sh
similarity index 100%
rename from runner-dist/src/main/bin/shutdown.sh
rename to runner-dist/apisix-runner-bin-dist/src/main/bin/shutdown.sh
diff --git a/runner-dist/src/main/bin/startup.sh
b/runner-dist/apisix-runner-bin-dist/src/main/bin/startup.sh
similarity index 100%
rename from runner-dist/src/main/bin/startup.sh
rename to runner-dist/apisix-runner-bin-dist/src/main/bin/startup.sh
diff --git a/runner-dist/pom.xml b/runner-dist/apisix-runner-src-dist/pom.xml
similarity index 83%
copy from runner-dist/pom.xml
copy to runner-dist/apisix-runner-src-dist/pom.xml
index 9b879f7..05f7339 100644
--- a/runner-dist/pom.xml
+++ b/runner-dist/apisix-runner-src-dist/pom.xml
@@ -22,25 +22,16 @@
<parent>
<groupId>org.apache.apisix</groupId>
- <artifactId>apisix-plugin-runner</artifactId>
+ <artifactId>apisix-runner-dist</artifactId>
<version>0.1.0-SNAPSHOT</version>
</parent>
- <artifactId>apisix-runner-dist</artifactId>
- <packaging>jar</packaging>
-
- <name>APISIX Java Plugin Runner Distribution</name>
-
- <dependencies>
- <dependency>
- <groupId>org.apache.apisix</groupId>
- <artifactId>apisix-runner-starter</artifactId>
- <version>0.1.0-SNAPSHOT</version>
- </dependency>
- </dependencies>
+ <artifactId>apisix-runner-src-dist</artifactId>
+ <packaging>pom</packaging>
+ <name>${project.artifactId}</name>
<build>
- <finalName>apisix-runner-bin</finalName>
+ <finalName>apisix-runner-src</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -72,8 +63,8 @@
</goals>
<configuration>
<target>
- <copy
file="${project.build.directory}/apisix-runner-bin.tar.gz"
-
tofile="${project.basedir}/../dist/apache-apisix-runner-bin.tar.gz"
+ <copy
file="${project.build.directory}/apisix-runner-src.tgz"
+
tofile="${project.basedir}/../../dist/apache-apisix-java-plugin-runner-${project.version}-src.tgz"
overwrite="true" />
</target>
</configuration>
diff --git a/runner-dist/apisix-runner-src-dist/src/main/assembly/assemble.xml
b/runner-dist/apisix-runner-src-dist/src/main/assembly/assemble.xml
new file mode 100644
index 0000000..b4d2951
--- /dev/null
+++ b/runner-dist/apisix-runner-src-dist/src/main/assembly/assemble.xml
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ 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.
+ ~
+ -->
+
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0
http://maven.apache.org/xsd/assembly-2.1.0.xsd";>
+ <id>src</id>
+ <formats>
+ <format>dir</format>
+ <format>tgz</format>
+ </formats>
+ <includeBaseDirectory>true</includeBaseDirectory>
+ <baseDirectory>${project.build.finalName}-src-release</baseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>../../</directory>
+ <useDefaultExcludes>true</useDefaultExcludes>
+ <includes>
+ <include>**/*</include>
+ </includes>
+ <excludes>
+ <!-- github ignore -->
+ <exclude>**/.github/**</exclude>
+
+ <!-- maven ignore -->
+ <exclude>**/target/**</exclude>
+ <exclude>**/*.class</exclude>
+ <exclude>**/*.jar</exclude>
+ <exclude>**/*.war</exclude>
+ <exclude>**/*.zip</exclude>
+ <exclude>**/*.tar</exclude>
+ <exclude>**/*.tar.gz</exclude>
+
+ <!-- maven plugin ignore -->
+ <exclude>release.properties</exclude>
+ <exclude>**/pom.xml.releaseBackup</exclude>
+ <exclude>**/cobertura.ser</exclude>
+ <exclude>*.gpg</exclude>
+
+ <!-- eclipse ignore -->
+ <exclude>**/.settings/**</exclude>
+ <exclude>**/.project</exclude>
+ <exclude>**/.classpath</exclude>
+
+ <!-- idea ignore -->
+ <exclude>**/.idea/**</exclude>
+ <exclude>**/*.ipr</exclude>
+ <exclude>**/*.iml</exclude>
+ <exclude>**/*.iws</exclude>
+
+ <!-- temp ignore -->
+ <exclude>**/logs/**</exclude>
+ <exclude>**/*.log</exclude>
+ <exclude>**/*.doc</exclude>
+ <exclude>**/*.cache</exclude>
+ <exclude>**/*.diff</exclude>
+ <exclude>**/*.patch</exclude>
+ <exclude>**/*.tmp</exclude>
+
+ <!-- system ignore -->
+ <exclude>**/.DS_Store</exclude>
+ <exclude>**/Thumbs.db</exclude>
+
+ <!-- modules ignore -->
+ <exclude>sample/**</exclude>
+ <exclude>runner-dist/**</exclude>
+ <exclude>docs/**</exclude>
+ </excludes>
+ </fileSet>
+ </fileSets>
+</assembly>
\ No newline at end of file
diff --git a/runner-dist/pom.xml b/runner-dist/pom.xml
index 9b879f7..0419b22 100644
--- a/runner-dist/pom.xml
+++ b/runner-dist/pom.xml
@@ -27,7 +27,7 @@
</parent>
<artifactId>apisix-runner-dist</artifactId>
- <packaging>jar</packaging>
+ <packaging>pom</packaging>
<name>APISIX Java Plugin Runner Distribution</name>
@@ -38,48 +38,8 @@
<version>0.1.0-SNAPSHOT</version>
</dependency>
</dependencies>
-
- <build>
- <finalName>apisix-runner-bin</finalName>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-assembly-plugin</artifactId>
- <configuration>
- <descriptors>
- <descriptor>src/main/assembly/assemble.xml</descriptor>
- </descriptors>
- <appendAssemblyId>false</appendAssemblyId>
- </configuration>
- <executions>
- <execution>
- <id>bin</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <id>dist</id>
- <phase>package</phase>
- <goals>
- <goal>run</goal>
- </goals>
- <configuration>
- <target>
- <copy
file="${project.build.directory}/apisix-runner-bin.tar.gz"
-
tofile="${project.basedir}/../dist/apache-apisix-runner-bin.tar.gz"
- overwrite="true" />
- </target>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
+ <modules>
+ <module>apisix-runner-bin-dist</module>
+ <module>apisix-runner-src-dist</module>
+ </modules>
</project>
\ No newline at end of file
