From 9de37b29171f3cf8063829aebd851ae681b7f856 Mon Sep 17 00:00:00 2001 From: Emil Lundberg Date: Tue, 4 Jun 2024 14:20:40 +0200 Subject: [PATCH 1/4] Document JDK version support philosohpy --- doc/development.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/development.md b/doc/development.md index 0acb00b5d..a6b562e85 100644 --- a/doc/development.md +++ b/doc/development.md @@ -2,6 +2,27 @@ Developer docs === +JDK versions +--- + +The project's official build JDK version is the latest LTS JDK version, +although the project may lag behind the true latest release for a while +until we can upgrade the build definition to match this target. + +The official build JDK version currently in effect is encoded in the +["Reproducible binary"](https://github.com/Yubico/java-webauthn-server/blob/main/.github/workflows/release-verify-signatures.yml) +workflow, +as the JDK version is crucial for successfully reproducing released binaries. +This version is also enforced in the release process in +[`build.gradle`](https://github.com/Yubico/java-webauthn-server/blob/main/build.gradle). + +The [primary build workflow](https://github.com/Yubico/java-webauthn-server/blob/main/.github/workflows/build.yml) +should run on all currently maintaned LTS JDK versions, +and ideally also the latest non-LTS JDK version if Gradle and other build dependencies are compatible. + +A list of JDK versions and maintenance status can be found [here](https://en.wikipedia.org/wiki/Java_version_history). + + Setup for publishing --- From 6c70489979558649883c09f8913b322034505045 Mon Sep 17 00:00:00 2001 From: Emil Lundberg Date: Tue, 4 Jun 2024 14:21:54 +0200 Subject: [PATCH 2/4] Move section "Code formatting" to before "Setup for publishing" --- doc/development.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/development.md b/doc/development.md index a6b562e85..7a4a07336 100644 --- a/doc/development.md +++ b/doc/development.md @@ -23,6 +23,14 @@ and ideally also the latest non-LTS JDK version if Gradle and other build depend A list of JDK versions and maintenance status can be found [here](https://en.wikipedia.org/wiki/Java_version_history). +Code formatting +--- + +Use `./gradlew spotlessApply` to run the automatic code formatter. +You can also run it in continuous mode as `./gradlew --continuous spotlessApply` +to reformat whenever a file changes. + + Setup for publishing --- @@ -35,11 +43,3 @@ yubicoPublish=true ossrhUsername=8pnmjKQP ossrhPassword=bmjuyWSIik8P3Nq/ZM2G0Xs0sHEKBg+4q4zTZ8JDDRCr ``` - - -Code formatting ---- - -Use `./gradlew spotlessApply` to run the automatic code formatter. -You can also run it in continuous mode as `./gradlew --continuous spotlessApply` -to reformat whenever a file changes. From 0da81b952996c4e31ac650f34b02f8200dc80381 Mon Sep 17 00:00:00 2001 From: Emil Lundberg Date: Tue, 4 Jun 2024 14:23:30 +0200 Subject: [PATCH 3/4] Add section "Publishing a release" to development.md --- doc/development.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/development.md b/doc/development.md index 7a4a07336..04d2de910 100644 --- a/doc/development.md +++ b/doc/development.md @@ -43,3 +43,9 @@ yubicoPublish=true ossrhUsername=8pnmjKQP ossrhPassword=bmjuyWSIik8P3Nq/ZM2G0Xs0sHEKBg+4q4zTZ8JDDRCr ``` + + +Publishing a release +--- + +See the [release checklist](./releasing.md). From 45a2bcf9dd2e0ab48ffcef275ac17b3cf3fd622a Mon Sep 17 00:00:00 2001 From: Emil Lundberg Date: Tue, 4 Jun 2024 14:24:55 +0200 Subject: [PATCH 4/4] Link to developer docs from main README --- README | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README b/README index 176303870..e2c0ff4c9 100644 --- a/README +++ b/README @@ -849,3 +849,9 @@ built artifacts. Official Yubico software signing keys are listed on the https://developers.yubico.com/Software_Projects/Software_Signing.html[Yubico Developers site]. + + +[#development] +=== Development + +See the link:https://github.com/Yubico/java-webauthn-server/blob/main/doc/development.md[developer docs].