Build windows without runfiles links by default. (#3366)

UebelAndre · web-flow · commit 922b8d0a8993 · 2025-03-22T23:30:49.000Z
diff --git a/.bazelci/presubmit.yml b/.bazelci/presubmit.yml
@@ -69,9 +69,6 @@ default_macos_targets: &default_macos_targets
 default_windows_targets: &default_windows_targets
   - "--" # Allows negative patterns; hack for https://github.com/bazelbuild/continuous-integration/pull/245
   - "//..."
-default_windows_no_runfiles_targets: &default_windows_no_runfiles_targets
-  - "--" # Allows negative patterns; hack for https://github.com/bazelbuild/continuous-integration/pull/245
-  - "//..."
 crate_universe_vendor_example_targets: &crate_universe_vendor_example_targets
   - "//vendor_external:crates_vendor"
   - "//vendor_local_manifests:crates_vendor"
@@ -148,15 +145,14 @@ tasks:
     shell_commands: *no_bzlmod_shell_commands
     build_targets: *default_windows_targets
     test_targets: *default_windows_targets
-  windows_no_runfiles:
-    name: No Runfiles
+  windows_with_runfiles:
+    name: With Runfiles
     platform: windows
-    build_flags:
-      - "--noenable_runfiles"
-    test_flags:
-      - "--noenable_runfiles"
-    build_targets: *default_windows_no_runfiles_targets
-    test_targets: *default_windows_no_runfiles_targets
+    batch_commands:
+      - echo startup --windows_enable_symlinks > user.bazelrc
+      - echo common --noenable_runfiles >> user.bazelrc
+    build_targets: *default_windows_targets
+    test_targets: *default_windows_targets
   ubuntu2004_split_coverage_postprocessing:
     name: Split Coverage Postprocessing
     platform: ubuntu2004
@@ -251,18 +247,19 @@ tasks:
     build_targets: *default_windows_targets
     test_targets: *default_windows_targets
   windows_no_runfiles_with_aspects:
-    name: No Runfiles With Aspects
+    name: With Runfiles With Aspects
     platform: windows
+    batch_commands:
+      - echo startup --windows_enable_symlinks > user.bazelrc
+      - echo common --noenable_runfiles >> user.bazelrc
     build_flags:
-      - "--noenable_runfiles"
       - "--config=rustfmt"
       - "--config=clippy"
     test_flags:
-      - "--noenable_runfiles"
       - "--config=rustfmt"
       - "--config=clippy"
-    build_targets: *default_windows_no_runfiles_targets
-    test_targets: *default_windows_no_runfiles_targets
+    build_targets: *default_windows_targets
+    test_targets: *default_windows_targets
   windows_rolling_with_aspects:
     name: "Windows Rolling Bazel Version With Aspects"
     platform: windows
diff --git a/.bazelrc b/.bazelrc
@@ -11,10 +11,6 @@ build --nobuild_runfile_links
 # https://bazel.build/reference/command-line-reference#flag--enable_platform_specific_config
 common --enable_platform_specific_config
 
-# https://bazel.build/docs/windows#symlink
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
 # Enable the only currently supported report type
 # https://bazel.build/reference/command-line-reference#flag--combined_report
 coverage --combined_report=lcov
diff --git a/.github/github.bazelrc b/.github/github.bazelrc
@@ -3,10 +3,6 @@
 # Always display the flags being used
 common --announce_rc
 
-# These settings make the windows workers behave similarly to unix workers
-startup --windows_enable_symlinks
-build --enable_runfiles
-
 # Show errors in CI
 test --test_output=errors
 
diff --git a/cargo/cargo_build_script_runner/cargo_manifest_dir.rs b/cargo/cargo_build_script_runner/cargo_manifest_dir.rs
@@ -279,7 +279,7 @@ impl RunfilesMaker {
     /// Delete runfiles from the runfiles directory that do not match user defined suffixes
     ///
     /// The Windows implementation assumes symlinks are not supported and real files will have
-    /// been copied into the runfiles directoriy.
+    /// been copied into the runfiles directory.
     fn drain_runfiles_dir_windows(&self) -> Result<(), String> {
         for dest in self.runfiles.values() {
             if !self
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -98,5 +98,3 @@ WORKSPACE support is officially tested with Bazel 7 for as long as that is the m
 We aim to support Linux and macOS.
 
 We do not have sufficient maintainer expertise to support Windows. Most things probably work, but we have had to disable many tests in CI because we lack the expertise to fix them. We welcome contributions to help improve its support.
-
-Windows support for some features requires `--enable_runfiles` to be passed to Bazel, we recommend putting it in your bazelrc. See [Using Bazel on Windows](https://bazel.build/configure/windows) for more Windows-specific recommendations.
diff --git a/examples/all_crate_deps/.bazelrc b/examples/all_crate_deps/.bazelrc
@@ -1,10 +1,3 @@
-# Required on windows
-common --enable_platform_specific_config
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
-build --experimental_enable_bzlmod
-
 # This isn't currently the defaut in Bazel, but we enable it to test we'll be ready if/when it flips.
 build --incompatible_disallow_empty_glob
 
diff --git a/examples/compile_opt/.bazelrc b/examples/compile_opt/.bazelrc
@@ -1,8 +1,3 @@
-# Required on windows
-common --enable_platform_specific_config
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
 # This isn't currently the defaut in Bazel, but we enable it to test we'll be ready if/when it flips.
 build --incompatible_disallow_empty_glob
 
diff --git a/examples/crate_universe/cargo_aliases/.bazelrc b/examples/crate_universe/cargo_aliases/.bazelrc
diff --git a/examples/crate_universe/cargo_remote/.bazelrc b/examples/crate_universe/cargo_remote/.bazelrc
diff --git a/examples/crate_universe/cargo_workspace/.bazelrc b/examples/crate_universe/cargo_workspace/.bazelrc
diff --git a/examples/crate_universe/multi_package/.bazelrc b/examples/crate_universe/multi_package/.bazelrc
diff --git a/examples/crate_universe/no_cargo_manifests/.bazelrc b/examples/crate_universe/no_cargo_manifests/.bazelrc
diff --git a/examples/override_target/.bazelrc b/examples/override_target/.bazelrc
@@ -1,10 +1,3 @@
-# Required on windows
-common --enable_platform_specific_config
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
-build --experimental_enable_bzlmod
-
 # This isn't currently the defaut in Bazel, but we enable it to test we'll be ready if/when it flips.
 build --incompatible_disallow_empty_glob
 
diff --git a/examples/zig_cross_compiling/.bazelrc b/examples/zig_cross_compiling/.bazelrc
@@ -1,13 +1,4 @@
-# Required on windows
-common --enable_platform_specific_config
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
 build --incompatible_enable_cc_toolchain_resolution
 
-# TODO: migrate all dependencies from WORKSPACE to MODULE.bazel
-# https://github.com/bazelbuild/rules_rust/issues/2181
-common --noenable_bzlmod
-
 # This isn't currently the defaut in Bazel, but we enable it to test we'll be ready if/when it flips.
 build --incompatible_disallow_empty_glob
diff --git a/extensions/protobuf/.bazelrc b/extensions/protobuf/.bazelrc
@@ -8,10 +8,6 @@
 # https://bazel.build/reference/command-line-reference#flag--enable_platform_specific_config
 common --enable_platform_specific_config
 
-# https://bazel.build/docs/windows#symlink
-startup --windows_enable_symlinks
-build:windows --enable_runfiles
-
 # Enable the only currently supported report type
 # https://bazel.build/reference/command-line-reference#flag--combined_report
 coverage --combined_report=lcov
diff --git a/test/cargo_build_script/resolve_abs_symlink_out_dir/BUILD.bazel b/test/cargo_build_script/resolve_abs_symlink_out_dir/BUILD.bazel
@@ -9,17 +9,17 @@ cargo_build_script(
     srcs = ["build.rs"],
     data = ["data.txt"],
     edition = "2018",
+    # TODO: Fix flake on windows.
+    target_compatible_with = select({
+        "@platforms//os:windows": ["@platforms//:incompatible"],
+        "//conditions:default": [],
+    }),
 )
 
 rust_test(
     name = "test",
     srcs = ["test.rs"],
     data = [":symlink_build_rs"],
     edition = "2018",
-    # TODO: Fix flake on windows.
-    target_compatible_with = select({
-        "@platforms//os:windows": ["@platforms//:incompatible"],
-        "//conditions:default": [],
-    }),
     deps = [":symlink_build_rs"],
 )
diff --git a/test/cargo_build_script/resolve_abs_symlink_out_dir/build.rs b/test/cargo_build_script/resolve_abs_symlink_out_dir/build.rs
@@ -24,5 +24,4 @@ fn main() {
     symlink("data.txt", "relative_symlink.txt");
     symlink("../data.txt", "nested/relative_symlink.txt");
     std::env::set_current_dir(&original_cwd).unwrap();
-    println!("{}", out_dir.display());
 }
diff --git a/test/unit/compile_data/compile_data_test.bzl b/test/unit/compile_data/compile_data_test.bzl
@@ -1,6 +1,7 @@
 """Unittest to verify compile_data (attribute) propagation"""
 
 load("@bazel_skylib//lib:unittest.bzl", "analysistest", "asserts")
+load("@bazel_skylib//rules:write_file.bzl", "write_file")
 load("//rust:defs.bzl", "rust_common", "rust_doc", "rust_library", "rust_test")
 load(
     "//test/unit:common.bzl",
@@ -95,10 +96,11 @@ def _define_test_targets():
         crate = ":compile_data_env",
     )
 
-    native.genrule(
+    write_file(
         name = "generated_compile_data",
-        outs = ["generated.txt"],
-        cmd = "echo 'generated compile data contents' > $@",
+        out = "generated.txt",
+        content = ["generated compile data contents", ""],
+        newline = "unix",
     )
 
     rust_library(
@@ -113,10 +115,11 @@ def _define_test_targets():
         crate = ":compile_data_gen",
     )
 
-    native.genrule(
+    write_file(
         name = "generated_src",
-        outs = ["generated.rs"],
-        cmd = """echo 'pub const GENERATED: &str = "generated";' > $@""",
+        out = "generated.rs",
+        content = ["pub const GENERATED: &str = \"generated\";", ""],
+        newline = "unix",
     )
 
     rust_library(

Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,4 @@ fn main() {`
`24`	`24`	`symlink("data.txt", "relative_symlink.txt");`
`25`	`25`	`symlink("../data.txt", "nested/relative_symlink.txt");`
`26`	`26`	`std::env::set_current_dir(&original_cwd).unwrap();`
`27`		`- println!("{}", out_dir.display());`
`28`	`27`	`}`