Skip to content

Commit

Permalink
Bump documentation version to 2.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kohlschuetter committed Apr 17, 2021
1 parent 475bb04 commit 904a5fb
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 31 deletions.
6 changes: 3 additions & 3 deletions src/site/markdown/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Versioning

junixsocket versions consist of three parts: major, minor and patch (for example, 2.3.3).
junixsocket versions consist of three parts: major, minor and patch (for example, 2.4.0).

`-SNAPSHOT` builds are not considered releases, but merely previews of a future release.

### junixsocket 2.3.3
### junixsocket 2.4.0

junixsocket 2.3.3 is fully compatible with Java 8 and newer (tested up to Java 16).
junixsocket 2.4.0 is fully compatible with Java 8 and newer (tested up to Java 16).

There is limited functionality for Java 7 systems: the core functionality (junixsocket-common and
junixsocket-server) is supported, but RMI, selftest and demos aren't.
Expand Down
6 changes: 3 additions & 3 deletions src/site/markdown/customarch.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ for development and testing purposes:
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-native-custom</artifactId>
<version>2.3.3</version>
<version>2.4.0</version>
<classifier>amd64-Linux-gpp-jni</classifier>
</dependency>

Expand All @@ -88,7 +88,7 @@ have your custom artifact, there's a chance it wouldn't even build on other peop
An alternative is to directly add the junixsocket-native-custom jar to the classpath whenever you
invoke the Java VM (e.g., your web server, etc.), for example:

java -cp junixsocket-native-custom-2.3.3-amd64-Linux-gpp-jni.jar:*(...)* *YourMainClass*
java -cp junixsocket-native-custom-2.4.0-amd64-Linux-gpp-jni.jar:*(...)* *YourMainClass*

## If that doesn't work...

Expand All @@ -98,7 +98,7 @@ the native library yourself.
Simply set the system property `org.newsclub.net.unix.library.override` to the path of the native
library. For example:

java -Dorg.newsclub.net.unix.library.override=/path/to/junixsocket-native-2.3.3.so (...)
java -Dorg.newsclub.net.unix.library.override=/path/to/junixsocket-native-2.4.0.so (...)

> **NOTE** If this override fails to load, an attempt is made to load the standard junixsocket library,
unless the system property `org.newsclub.net.unix.library.override.force` is set to `true`.
2 changes: 1 addition & 1 deletion src/site/markdown/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ as expected.

junixsocket-dist provides a self-contained jar that performs this selftest:

java -jar junixsocket-selftest-2.3.3-jar-with-dependencies.jar
java -jar junixsocket-selftest-2.4.0-jar-with-dependencies.jar

The last line should say "Selftest PASSED", and you're good to go.

Expand Down
33 changes: 17 additions & 16 deletions src/site/markdown/dependency.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ Add the following dependency to your Maven project
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-core</artifactId>
<version>2.3.3</version>
<version>2.4.0</version>
<type>pom</type>
</dependency>

[See here](customarch.html) how to add support for custom architectures that aren't supported out of the box.
Expand All @@ -22,38 +23,38 @@ If you're going to use AFUNIXSocketServer code, add the following dependency:
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-server</artifactId>
<version>2.3.3</version>
<version>2.4.0</version>
</dependency>

If you're going to use RMI over Unix sockets, add the following dependency:

<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-rmi</artifactId>
<version>2.3.3</version>
<version>2.4.0</version>
</dependency>

If you're going to use the mySQL Connector for Unix sockets, add the following dependency:

<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-mysql</artifactId>
<version>2.3.3</version>
<version>2.4.0</version>
</dependency>

## Gradle

Minimum requirement:

compile 'com.kohlschutter.junixsocket:junixsocket-core:2.3.3'
compile 'com.kohlschutter.junixsocket:junixsocket-core:2.4.0'

For RMI support, add:

compile 'com.kohlschutter.junixsocket:junixsocket-rmi:2.3.3'
compile 'com.kohlschutter.junixsocket:junixsocket-rmi:2.4.0'

For MySQL support, add:

compile 'com.kohlschutter.junixsocket:junixsocket-mysql:2.3.3'
compile 'com.kohlschutter.junixsocket:junixsocket-mysql:2.4.0'

## jars only

Expand All @@ -74,12 +75,12 @@ databases such as PostgreSQL.

Make sure that the following jars are on your classpath:

* junixsocket-core-2.3.3.jar
* junixsocket-common-2.3.3.jar
* junixsocket-mysql-2.3.3.jar
* junixsocket-core-2.4.0.jar
* junixsocket-common-2.4.0.jar
* junixsocket-mysql-2.4.0.jar
* mysql-connector-java-8.0.14.jar (earlier versions should work, too)
* (typically, omit if you use the custom library below) junixsocket-native-common-2.3.3.jar
* (optionally, if you have a custom architecture) junixsocket-native-custom-2.3.3.jar
* (typically, omit if you use the custom library below) junixsocket-native-common-2.4.0.jar
* (optionally, if you have a custom architecture) junixsocket-native-custom-2.4.0.jar

Use the following connection properties (along with `user`, `password`, and other properties you may have).

Expand Down Expand Up @@ -107,11 +108,11 @@ to disable SSL with older versions of Connector/J.

Make sure that the following jars are on your classpath:

* junixsocket-core-2.3.3.jar
* junixsocket-common-2.3.3.jar
* junixsocket-core-2.4.0.jar
* junixsocket-common-2.4.0.jar
* postgresql-42.2.5.jar (earlier versions should work, too)
* (typically, omit if you use the custom library below) junixsocket-native-common-2.3.3.jar
* (optionally, if you have a custom architecture) junixsocket-native-custom-2.3.3.jar
* (typically, omit if you use the custom library below) junixsocket-native-common-2.4.0.jar
* (optionally, if you have a custom architecture) junixsocket-native-custom-2.4.0.jar


Use the following connection properties (along with `user`, `password`, and other properties you may have).
Expand Down
1 change: 0 additions & 1 deletion src/site/markdown/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ And here are some other useful resources:

* [Issue tracker on GitHub](https://github.com/kohlschutter/junixsocket/issues)
* [Official website](https://kohlschutter.github.io/junixsocket/)

14 changes: 7 additions & 7 deletions src/site/markdown/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ install Java, Maven and junixsocket, and you should be good to go.
### Bump project version

cd junixsocket
mvn versions:set -DnewVersion=2.3.3
mvn versions:set -DnewVersion=2.4.0
# git add / commit here...

### Build native libraries on other supported, common platforms
Expand All @@ -86,8 +86,8 @@ The platform-dependent nar files should now be available in the local maven repo
Use the provided script to copy the corresponding nar to a project folder:

cd junixsocket
# replace 2.3.3 with the desired version number
junixsocket-native-prebuilt/bin/copy-nar-from-m2repo.sh 2.3.3
# replace 2.4.0 with the desired version number
junixsocket-native-prebuilt/bin/copy-nar-from-m2repo.sh 2.4.0

Now copy the nar files from the target machine to your development computer (from where you do the release).
By convention, copy the files to the same folder as on the target machine (*junixsocket/junixsocket-native-prebuilt/bin*)
Expand All @@ -107,9 +107,9 @@ a script to run the demo classes from the command-line.

The files can be found in

* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.3.3-bin`
* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.3.3-bin.tar.gz`
* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.3.3-bin.zip`
* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.4.0-bin`
* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.4.0-bin.tar.gz`
* `junixsocket/junixsocket-dist/target/junixsocket-dist-2.4.0-bin.zip`

### Deploy code to Maven central

Expand Down Expand Up @@ -177,7 +177,7 @@ NOTE: There can be quite a delay (30 minutes?) until the artifact is deployed in

2. Select the newly created tag (= search for the version).

3. Release title = "junixsocket" + version>, e.g., "junixsocket 2.3.3"
3. Release title = "junixsocket" + version>, e.g., "junixsocket 2.4.0"

4. Hit "Publish release"

Expand Down

0 comments on commit 904a5fb

Please sign in to comment.