Run CI on Windows (#268)

Fixes #265 
Closes #235

Author: illicitonion

.bazelrc

@@ -15,5 +15,7 @@ build --tool_java_language_version=17
 test --verbose_failures
 test --test_output=errors
 
+import %workspace%/.bazelrc.windows
+
 # Load any settings specific to the current user.
 try-import %workspace%/.bazelrc.user

.bazelrc.windows

@@ -0,0 +1,4 @@
+# Make things work on Windows
+common --enable_platform_specific_config
+startup --windows_enable_symlinks
+build:windows --enable_runfiles

.github/workflows/gazelle_examples.yaml

@@ -14,12 +14,19 @@ jobs:
       matrix:
         runs-on:
           - ubuntu-latest
+          - windows-latest
 
     runs-on: ${{ matrix.runs-on }}
 
     steps:
       - uses: actions/checkout@v3
 
+      # The windows-latest image comes with Java 8 but rules_jvm_external requires at least 11, so we install a newer JDK.
+      - uses: actions/setup-java@v4
+        with:
+          distribution: "zulu"
+          java-version: "21"
+
       - uses: bazelbuild/setup-bazelisk@v2
 
       - name: Mount bazel action cache

.github/workflows/tests.yaml

@@ -16,6 +16,7 @@ jobs:
     strategy:
       matrix:
         runs-on:
+          # Most of the tests don't run on Windows, so we have a separate job for running just the ones that do.
           - ubuntu-latest
         flags:
           - ""

.github/workflows/tests_windows.yaml

@@ -0,0 +1,48 @@
+name: Tests (Windows)
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # We don't run the tests in the main test job because most of them don't work on Windows, but the Gazelle ones should, so we run those.
+  test_windows:
+    strategy:
+      matrix:
+        runs-on:
+          - windows-latest
+
+    runs-on: ${{ matrix.runs-on }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # The windows-latest image comes with Java 8 but rules_jvm_external requires at least 11, so we install a newer JDK.
+      - uses: actions/setup-java@v4
+        with:
+          distribution: "zulu"
+          java-version: "21"
+
+      - uses: bazelbuild/setup-bazelisk@v2
+
+      - name: Mount bazel action cache
+        uses: actions/cache@v2
+        with:
+          path: "~/.cache/bazel"
+          key: bazel
+
+      - name: Mount bazel repo cache
+        uses: actions/cache@v2
+        with:
+          path: "~/.cache/bazel-repo"
+          key: bazel-repo
+
+      - name: bzlmod gazelle
+        env:
+          # Bazelisk will download bazel to here, ensure it is cached between runs.
+          XDG_CACHE_HOME: ~/.cache/bazel-repo
+        run: bazelisk --bazelrc=.github/workflows/ci.bazelrc test //java/gazelle/...

MODULE.bazel

@@ -31,6 +31,12 @@ bazel_dep(
     version = "0.36.0",
     repo_name = "bazel_gazelle",
 )
+git_override(
+    module_name = "gazelle",
+    commit = "ba2ce367a545e0bdd74a7abca40ef5e0a0cb8dcb",
+    remote = "https://github.com/bazelbuild/bazel-gazelle.git",
+)
+
 bazel_dep(
     name = "protobuf",
     version = PROTOBUF_VERSION,

examples/gazelle/.bazelrc

@@ -1,5 +1 @@
-common --enable_platform_specific_config
-
-# https://bazel.build/docs/windows#symlink
-startup --windows_enable_symlinks
-run:windows --enable_runfiles
+import %workspace%/../../.bazelrc.windows

examples/gazelle/MODULE.bazel

@@ -43,3 +43,8 @@ bazel_dep(
     name = "gazelle",
     version = "0.36.0",
 )
+git_override(
+    module_name = "gazelle",
+    commit = "ba2ce367a545e0bdd74a7abca40ef5e0a0cb8dcb",
+    remote = "https://github.com/bazelbuild/bazel-gazelle.git",
+)

examples/gazelle/src/test/com/example/gazelle/BUILD.bazel

@@ -1,5 +1,5 @@
-load("@contrib_rules_jvm//java:defs.bzl", "java_test_suite")
 load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
+load("@contrib_rules_jvm//java:defs.bzl", "java_test_suite")
 
 genquery(
     name = "generated_targets",

examples/tests_and_lints/.bazelrc

@@ -0,0 +1 @@
+import %workspace%/../../.bazelrc.windows