Skip to content

Commit bf56ff8

Browse files
scottfscottf
committed
Upgrade to Java 21
1 parent 7cf8d0f commit bf56ff8

File tree

13 files changed

+543
-379
lines changed

13 files changed

+543
-379
lines changed

‎.github/workflows/build-main.yml‎

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,57 @@
11
name: Build Main
2-
2+
permissions:
3+
contents: read
34
on:
45
push:
56
branches:
67
- main
78

89
jobs:
910
build:
11+
strategy:
12+
matrix:
13+
jdk: [ 21, 25 ]
1014
runs-on: ubuntu-latest
1115
env:
1216
BUILD_EVENT: ${{ github.event_name }}
17+
TARGET_COMPATIBILITY: ${{ matrix.jdk }}
1318
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
1419
OSSRH_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
1520
SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
1621
SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
1722
SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
18-
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
1923
steps:
20-
- name: Setup JDK 8
21-
uses: actions/setup-java@v4
24+
- name: Setup JDK
25+
uses: actions/setup-java@v5
26+
with:
27+
java-version: ${{ matrix.jdk }}
28+
distribution: 'temurin'
29+
- name: Setup Gradle
30+
uses: gradle/actions/setup-gradle@v5
2231
with:
23-
java-version: '8'
24-
distribution: 'adopt'
32+
gradle-version: current
2533
- name: Check out code
2634
uses: actions/checkout@v4
2735
- name: Build and Test
28-
run: chmod +x gradlew && ./gradlew clean test jacocoTestReport coveralls
36+
run: chmod +x gradlew && ./gradlew clean test jacocoTestReport
2937
- name: Verify Javadoc
3038
run: ./gradlew javadoc
31-
- name: Verify and Publish Snapshot
39+
- name: Send coverage to Coveralls
40+
uses: coverallsapp/github-action@v2
41+
with:
42+
github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
43+
parallel: true
44+
flag-name: jdk-${{ matrix.jdk }}
45+
- name: Publish Snapshot
3246
run: ./gradlew -i publishToSonatype
47+
48+
coveralls-finish:
49+
needs: build
50+
runs-on: ubuntu-latest
51+
steps:
52+
- name: Coveralls Finish
53+
uses: coverallsapp/github-action@v2
54+
with:
55+
github-token: ${{ secrets.GITHUB_TOKEN }}
56+
parallel-finished: true
57+
carryforward: "jdk-21"

‎.github/workflows/build-pr.yml‎

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,49 @@
11
name: Build Pull Request
2-
2+
permissions:
3+
contents: read
34
on:
45
pull_request:
56
types: [opened, synchronize, edited, reopened]
67

78
jobs:
89
build:
10+
strategy:
11+
matrix:
12+
jdk: [ 21, 25 ]
913
runs-on: ubuntu-latest
1014
env:
1115
BUILD_EVENT: ${{ github.event_name }}
12-
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
16+
TARGET_COMPATIBILITY: ${{ matrix.jdk }}
1317
steps:
14-
- name: Setup JDK 8
15-
uses: actions/setup-java@v4
18+
- name: Setup JDK
19+
uses: actions/setup-java@v5
20+
with:
21+
java-version: ${{ matrix.jdk }}
22+
distribution: 'temurin'
23+
- name: Setup Gradle
24+
uses: gradle/actions/setup-gradle@v5
1625
with:
17-
java-version: '8'
18-
distribution: 'adopt'
26+
gradle-version: current
1927
- name: Check out code
2028
uses: actions/checkout@v4
2129
- name: Build and Test
22-
run: chmod +x gradlew && ./gradlew clean test jacocoTestReport coveralls
30+
run: chmod +x gradlew && ./gradlew clean test jacocoTestReport
2331
- name: Verify Javadoc
2432
run: ./gradlew javadoc
33+
- name: Send coverage to Coveralls
34+
uses: coverallsapp/github-action@v2
35+
with:
36+
github-token: ${{ secrets.COVERALLS_REPO_TOKEN }}
37+
parallel: true
38+
flag-name: jdk-${{ matrix.jdk }}
39+
40+
coveralls-finish:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
steps:
44+
- name: Coveralls Finish
45+
uses: coverallsapp/github-action@v2
46+
with:
47+
github-token: ${{ secrets.GITHUB_TOKEN }}
48+
parallel-finished: true
49+
carryforward: "jdk-21"

‎.github/workflows/build-release.yml‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
name: Build Release
2-
2+
permissions:
3+
contents: read
34
on:
45
release:
56
branches:
@@ -8,25 +9,33 @@ on:
89

910
jobs:
1011
build:
12+
strategy:
13+
matrix:
14+
jdk: [ 21, 25 ]
1115
runs-on: ubuntu-latest
1216
env:
1317
BUILD_EVENT: ${{ github.event_name }}
18+
TARGET_COMPATIBILITY: ${{ matrix.jdk }}
1419
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
1520
OSSRH_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
1621
SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
1722
SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
1823
SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
1924
steps:
20-
- name: Setup JDK 8
21-
uses: actions/setup-java@v4
25+
- name: Setup JDK
26+
uses: actions/setup-java@v5
27+
with:
28+
java-version: ${{ matrix.jdk }}
29+
distribution: 'temurin'
30+
- name: Setup Gradle
31+
uses: gradle/actions/setup-gradle@v5
2232
with:
23-
java-version: '8'
24-
distribution: 'adopt'
33+
gradle-version: current
2534
- name: Check out code
2635
uses: actions/checkout@v4
2736
- name: Build and Test
2837
run: chmod +x gradlew && ./gradlew clean test
2938
- name: Verify Javadoc
3039
run: ./gradlew javadoc
3140
- name: Verify, Sign and Publish Release
32-
run: ./gradlew -i signArchives signMavenJavaPublication publishToSonatype closeAndReleaseSonatypeStagingRepository
41+
run: ./gradlew -i publishToSonatype closeAndReleaseSonatypeStagingRepository

‎README.md‎

Lines changed: 98 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44

55
The library allows you to create and use NKEYS in Java code.
66

7-
**Current Release**: 2.1.1   **Current Snapshot**: 2.1.2-SNAPSHOT
7+
![3.0.0](https://img.shields.io/badge/Current_Release-3.0.0-27AAE0?style=for-the-badge)
8+
![3.0.1](https://img.shields.io/badge/Current_Snapshot-3.0.1--SNAPSHOT-27AAE0?style=for-the-badge)
89

9-
[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
10-
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.nats/nkeys-java/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.nats/nkeys-java)
11-
[![Javadoc](http://javadoc.io/badge/io.nats/nkeys-java.svg?branch=main)](http://javadoc.io/doc/io.nats/nkeys-java?branch=main)
12-
[![Coverage Status](https://coveralls.io/repos/github/nats-io/nkeys.java/badge.svg?branch=main)](https://coveralls.io/github/nats-io/nkeys.java?branch=main)
1310
[![Build Main Badge](https://github.com/nats-io/nkeys.java/actions/workflows/build-main.yml/badge.svg?event=push)](https://github.com/nats-io/nkeys.java/actions/workflows/build-main.yml)
14-
[![Release Badge](https://github.com/nats-io/nkeys.java/actions/workflows/build-release.yml/badge.svg?event=release)](https://github.com/nats-io/nkeys.java/actions/workflows/build-release.yml)
11+
[![Coverage Status](https://coveralls.io/repos/github/nats-io/nkeys.java/badge?branch=main)](https://coveralls.io/github/nats-io/nkeys.java?branch=main)
12+
[![Maven JDK 21](https://img.shields.io/maven-central/v/io.nats/nkeys-java-jdk21?label=maven-central-jdk21)](https://mvnrepository.com/artifact/io.nats/nkeys-java-jdk21)
13+
[![Maven JDK 25](https://img.shields.io/maven-central/v/io.nats/nkeys-java-jdk25?label=maven-central-jdk25)](https://mvnrepository.com/artifact/io.nats/nkeys-java-jdk25)
14+
[![Javadoc](http://javadoc.io/badge/io.nats/nkeys-java-jdk21.svg?branch=main)](http://javadoc.io/doc/io.nats/nkeys-java-jdk21?branch=main)
15+
[![License Apache 2](https://img.shields.io/badge/License-Apache2-blue)](https://www.apache.org/licenses/LICENSE-2.0)
1516

1617
# Overview
1718

@@ -62,7 +63,97 @@ The NATS system will utilize public NKeys for identification, the NATS system
6263
will never store or even have access to any private keys or seeds.
6364
Authentication will utilize a challenge-response mechanism based on a
6465
collection of random bytes called a nonce.
65-
66+
### JDK Version
67+
68+
This project uses Java 21 Language Level api, but builds with both Java 21 and Java 25, so creates two different artifacts.
69+
Both have the same group id `io.nats`, and the same version but have different artifact names.
70+
71+
* The Java 21 artifact id is `nkeys-java-jdk21`
72+
* The Java 25 artifact id is `nkeys-java-jdk25`
73+
74+
### Dependency Management
75+
76+
The NATS client is available in the Maven central repository,
77+
and can be imported as a standard dependency in your `build.gradle` or `pom.xml` file,
78+
The examples shown use the jdk 21 version, to the jdk 25 version just change the artifact id.
79+
80+
#### Gradle
81+
82+
```groovy
83+
dependencies {
84+
implementation 'io.nats:nkeys-java-jdk21:3.0.0'
85+
}
86+
```
87+
88+
If you need the latest and greatest before Maven central updates, you can use:
89+
90+
```groovy
91+
repositories {
92+
mavenCentral()
93+
maven {
94+
url "https://repo1.maven.org/maven2/"
95+
}
96+
}
97+
```
98+
99+
If you need a snapshot version, you must add the url for the snapshots and change your dependency.
100+
101+
```groovy
102+
repositories {
103+
mavenCentral()
104+
maven {
105+
url "https://central.sonatype.com/repository/maven-snapshots"
106+
}
107+
}
108+
109+
dependencies {
110+
implementation 'io.nats:nkeys-java-jdk21:3.0.1-SNAPSHOT'
111+
}
112+
```
113+
114+
#### Maven
115+
116+
```xml
117+
<dependency>
118+
<groupId>io.nats</groupId>
119+
<artifactId>nkeys-java-jdk21</artifactId>
120+
<version>3.0.0</version>
121+
</dependency>
122+
```
123+
124+
If you need the absolute latest, before it propagates to maven central, you can use the repository:
125+
126+
```xml
127+
<repositories>
128+
<repository>
129+
<id>sonatype releases</id>
130+
<url>https://repo1.maven.org/maven2/</url>
131+
<releases>
132+
<enabled>true</enabled>
133+
</releases>
134+
</repository>
135+
</repositories>
136+
```
137+
138+
If you need a snapshot version, you must enable snapshots and change your dependency.
139+
140+
```xml
141+
<repositories>
142+
<repository>
143+
<id>sonatype snapshots</id>
144+
<url>https://central.sonatype.com/repository/maven-snapshots</url>
145+
<snapshots>
146+
<enabled>true</enabled>
147+
</snapshots>
148+
</repository>
149+
</repositories>
150+
151+
<dependency>
152+
<groupId>io.nats</groupId>
153+
<artifactId>nkeys-java-jdk21</artifactId>
154+
<version>3.0.1-SNAPSHOT</version>
155+
</dependency>
156+
```
66157

67158
## License
68159

0 commit comments

Comments
 (0)