Build native binary in CI (fixes google#894)

This uses a container to simplify GraalVM installation.

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-# Copyright 2020 The Error Prone Authors.
+# Copyright 2020-2024 The Google Java Format Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -72,6 +72,8 @@ jobs:
       - name: 'Test'
         shell: bash
         run: ./mvnw test -B
+      - name: 'Native'
+        run: ./build-natives.sh
 
   publish_snapshot:
     name: 'Publish snapshot'

.github/workflows/release.yml

@@ -1,3 +1,17 @@
+# Copyright 2020-2024 The Google Java Format Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: Release google-java-format
 
 on:
@@ -53,17 +67,21 @@ jobs:
         run:
           ./mvnw --no-transfer-progress -pl 'eclipse_plugin' verify gpg:sign -DskipTests=true -Dgpg.passphrase="${{ secrets.GPG_PASSPHRASE }}"
 
+      - name: Build Native binaries with GraalVM in a Container
+        run:
+          ./build-natives.sh
+
       - name: Push tag
         run: |
           git push origin "v${{ github.event.inputs.version }}"
 
-      - name: Add Jars to Release Entry
+      - name: Add JARs to Release Entry
         uses: softprops/action-gh-release@v0.1.14
         with:
           draft: true
           name: ${{ github.event.input.version }}
           tag_name: "v${{ github.event.inputs.version }}"
           target_commitish: ${{ env.TARGET_COMMITISH }}
           files: |
-            core/target/google-java-format-*.jar
+            core/target/google-java-format*
             eclipse_plugin/target/google-java-format-eclipse-plugin-*.jar

.gitignore

@@ -15,3 +15,4 @@ out/
 eclipse_plugin/lib/
 
 .mvn/wrapper/maven-wrapper.jar
+.cache

Dockerfile

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2015-2024 The Google Java Format Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+FROM ghcr.io/graalvm/native-image-community:21
+
+# TODO Use RUN --mount=type=bind,source= instead
+WORKDIR /build/
+ADD . /build/
+
+RUN --mount=type=cache,target=/root/.m2/ ./mvnw -Pnative -DskipTests package -pl core -am

README.md

@@ -154,14 +154,17 @@ Your starting point should be the instance methods of
 ./mvnw install
 ```
 
+The _native_ binaries can be built with `./build-natives.sh` and will be
+available as `.cache/container-target/google-java-format` (requires Docker).
+
 ## Contributing
 
 Please see [the contributors guide](CONTRIBUTING.md) for details.
 
 ## License
 
 ```text
-Copyright 2015 Google Inc.
+Copyright 2015-2024 Google Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not
 use this file except in compliance with the License. You may obtain a copy of

build-natives.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+# SPDX-License-Identifier: Apache-2.0
+#
+# Copyright 2015-2024 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -euox pipefail
+
+mkdir core/target/
+docker build -t google-java-format-native --rm .
+id=$(docker create google-java-format-native)
+docker cp "$id":/build/core/target/google-java-format core/target/google-java-format_linux-x86_64
+docker rm -v "$id"
+
+chmod +x core/target/google-java-format_linux-x86_64
+core/target/google-java-format_linux-x86_64
+# This ^^^ isn't just to "look nice" in log, but *required* to TEST it! (Script & build will fail if NOK.)
+
+# TODO This only builds a Linux ABI Native Binary so far - later also build a Win/Mac one... (but how?)

core/pom.xml

@@ -282,7 +282,7 @@
           <plugin>
             <groupId>org.graalvm.buildtools</groupId>
             <artifactId>native-maven-plugin</artifactId>
-            <version>0.9.13</version>
+            <version>0.10.0</version>
             <extensions>true</extensions>
             <executions>
               <execution>