try to fix CI docc validation by guessing JAVA_HOME

Author: ktoso

.github/workflows/pull_request.yml

@@ -13,6 +13,30 @@ jobs:
       # FIXME: Something is off with the format task and it gets "stuck", need to investigate
       format_check_enabled: false
       license_header_check_project_name: Swift.org
+      # We need JAVA_HOME to be set to build the Swift project, so the default check would not do that.
+      docs_check_enabled: false
+
+  soundness-docs:
+    name: Soundness (Documentation) (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        # swift_version: ['nightly-main']
+        swift_version: ['6.0.2']
+        os_version: ['jammy']
+        jdk_vendor: ['Corretto']
+    container:
+      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
+    env:
+      JAVA_HOME: "/usr/lib/jvm/default-jdk"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Prepare CI Environment
+        uses: ./.github/actions/prepare_env
+      - name: "Soundness (Documentation)"
+        run: apt-get -qq update && apt-get -qq -y install curl yq && \
+             curl -s https://raw.githubusercontent.com/swiftlang/github-workflows/refs/heads/main/.github/workflows/scripts/check-docs.sh | bash
 
   test-java:
     name: Java tests (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})

Package.swift

@@ -26,6 +26,14 @@ func findJavaHome() -> String {
     return home
   }
 
+  // Detect we're on CI and try to guess the JAVA_HOME for the shared Swift Soundness scripts
+  if ProcessInfo.processInfo.environment["GITHUB_ACTIONS"] != nil {
+    let defaultCIJDKPath = "/usr/lib/jvm/default-jdk"
+    if FileManager.default.fileExists(atPath: defaultCIJDKPath) {
+      return defaultCIJDKPath
+    }
+  }
+
   fatalError("Please set the JAVA_HOME environment variable to point to where Java is installed.")
 }
 let javaHome = findJavaHome()
@@ -410,4 +418,4 @@ case "true", "TRUE", "yes", "YES", "1":
   )
 default:
   ()
-}
+}

Sources/JExtractSwift/JExtractSwift.docc/JExtractSwift.md

@@ -38,7 +38,6 @@ func callMe(maybe: () -> ()) {}
 ```
 
 
-
 ## `jextract-swift` importer behavior
 
 Only `public` functions, properties and types are imported.
@@ -60,3 +59,4 @@ public final class SomeModule ... {
     public static void globalFunction() { ... }
 }
 ```
+

Sources/SwiftJava/SwiftJava.docc/SwiftJava.md

@@ -2,17 +2,8 @@
 
 Java interoperability for Swift. 
 
-This project offers both ways to simplify using JNI to call from Swift code into Java libraryes (primarily centered around the `JavaKit` library),
+This project offers both ways to simplify using JNI to call from Swift code into Java libraries (primarily centered around the `JavaKit` library),
 as well as a way to generate Java wrappers around existing Swift code to ease consumption of Swift libraries from Java.
 
-Please refer to 
+The project is in early development so please reach out on github or the [swift forums](https://forums.swift.org) 
 
-## Topics
-
-### Calling Swift From Java
-
-- ``JavaKit/JavaKit``
-
-### Calling Java From Swift
-
-### In depth

Sources/SwiftJava/dummy.swift

@@ -12,4 +12,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-// empty on purpose
+// empty on purpose
+
+public func swiftkit_dummy() {}