Skip to content

Commit

Permalink
Update versions in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kohlschuetter committed Jul 1, 2022
1 parent c77dbd9 commit 22615d9
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 36 deletions.
2 changes: 1 addition & 1 deletion src/site/markdown/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ artifact (`<type>pom</type>`); see [Add junixsocket to your project](dependency.

- Add support for IBM z/OS (experimental, binary not included)
- Add support for building from source on arm64-Linux
- Add junixsocket support for jetty via [junixsocket-jetty](junixsocket-jetty/index.html)
- Add junixsocket support for jetty via [junixsocket-jetty](http://kohlschutter.github.io/junixsocket/junixsocket-jetty/)
- Fix Selector logic (more bug fixes)
- Documentation updates

Expand Down
8 changes: 4 additions & 4 deletions src/site/markdown/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

## Versioning

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

"Minor version" updates (e.g., 2.4.0 -> 2.5.0) can still bring "major" new features but they
should be backwards compatible to releases of the same "major version" (e.g., 2.x).

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

### junixsocket 2.5.0
### junixsocket 2.5.1

junixsocket 2.5.0 is fully compatible with Java 8 and newer (tested up to Java 19).
junixsocket 2.5.1 is fully compatible with Java 8 and newer (tested up to Java 19).

junixsocket has been tested to work with Oracle's Java 8 JDK, and OpenJDK for newer versions.

Expand Down Expand Up @@ -82,7 +82,7 @@ or [contact Christian Kohlschütter via email](mailto:[email protected]

A reliable way to ensure that junixsocket works in your environment is to run the "[selftest](selftest.html)".

java -jar junixsocket-selftest-2.5.0-jar-with-dependencies.jar
java -jar junixsocket-selftest-2.5.1-jar-with-dependencies.jar

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

Expand Down
8 changes: 4 additions & 4 deletions src/site/markdown/customarch.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ for development and testing purposes:
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-native-custom</artifactId>
<version>2.5.0</version>
<version>2.5.1</version>
<classifier>amd64-Linux-gpp-jni</classifier>
</dependency>

Expand All @@ -99,7 +99,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.5.0-amd64-Linux-gpp-jni.jar:*(...)* *YourMainClass*
java -cp junixsocket-native-custom-2.5.1-amd64-Linux-gpp-jni.jar:*(...)* *YourMainClass*

## If that doesn't work...

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

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

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`.

You can also specify the absolute path with the system property
`org.newsclub.net.unix.library.override.force`, which essentially combines these two declarations, i.e.

java -Dorg.newsclub.net.unix.library.override.force=/path/to/junixsocket-native-2.5.0.so (...)
java -Dorg.newsclub.net.unix.library.override.force=/path/to/junixsocket-native-2.5.1.so (...)

## If that doesn't work either...

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

Expand All @@ -25,31 +25,31 @@ If you're going to use AFUNIXSocketServer code, add the following dependency:
<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-server</artifactId>
<version>2.5.0</version>
<version>2.5.1</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.5.0</version>
<version>2.5.1</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.5.0</version>
<version>2.5.1</version>
</dependency>

If you're going to use TIPC, add the following dependency:

<dependency>
<groupId>com.kohlschutter.junixsocket</groupId>
<artifactId>junixsocket-tipc</artifactId>
<version>2.5.0</version>
<version>2.5.1</version>
</dependency>

If you're going to use the Jetty connectors, add the following dependency:
Expand All @@ -64,19 +64,19 @@ If you're going to use the Jetty connectors, add the following dependency:

Minimum requirement:

compile 'com.kohlschutter.junixsocket:junixsocket-core:2.5.0'
compile 'com.kohlschutter.junixsocket:junixsocket-core:2.5.1'

For RMI support, add:

compile 'com.kohlschutter.junixsocket:junixsocket-rmi:2.5.0'
compile 'com.kohlschutter.junixsocket:junixsocket-rmi:2.5.1'

For MySQL support, add:

compile 'com.kohlschutter.junixsocket:junixsocket-mysql:2.5.0'
compile 'com.kohlschutter.junixsocket:junixsocket-mysql:2.5.1'

For TIPC support, add:

compile 'com.kohlschutter.junixsocket:junixsocket-tipc:2.5.0'
compile 'com.kohlschutter.junixsocket:junixsocket-tipc:2.5.1'

For Jetty support, add:

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

Make sure that the following jars are on your classpath:

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

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

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

Make sure that the following jars are on your classpath:

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


Use the following connection properties (along with `user`, `password`, and other properties you may have).
Expand Down
25 changes: 16 additions & 9 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.5.0
mvn versions:set -DnewVersion=2.5.1
# 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.5.0 with the desired version number
junixsocket-native-prebuilt/bin/copy-nar-from-m2repo.sh 2.5.0
# replace 2.5.1 with the desired version number
junixsocket-native-prebuilt/bin/copy-nar-from-m2repo.sh 2.5.1

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 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.5.0"
3. Release title = "junixsocket" + version>, e.g., "junixsocket 2.5.1"

4. Paste changelog contents to text field

Expand All @@ -189,14 +189,21 @@ NOTE: There can be quite a delay (30 minutes?) until the artifact is deployed in

### Publish website

This builds the Maven site and publishes it to [https://kohlschutter.github.io/junixsocket/](https://kohlschutter.github.io/junixsocket/).
This builds the Maven site

cd junixsocket
mvn clean install site -Pstrict,release && \
cd junixsocket
mvn clean && \
mvn install site -Pstrict,release && \
mvn javadoc:aggregate -P '!with-native,!with-non-modularized,strict,release' && \
mvn jxr:aggregate jxr:test-aggregate -P strict,release && \
mvn site:stage -Pstrict,release && \
mvn scm-publish:publish-scm -Pstrict,release
mvn site:stage -Pstrict,release

The website should now be inspected at `junixsocket/target/staging/index.html`

If everything looks good, we can publish it to
[https://kohlschutter.github.io/junixsocket/](https://kohlschutter.github.io/junixsocket/):

mvn scm-publish:publish-scm -Pstrict,release

NOTE: There can be a 10-minute delay until the pages get updated automatically in your browser cache.
Hit refresh to expedite.
Expand Down

0 comments on commit 22615d9

Please sign in to comment.