Disable Windows build on CI and add note to README

shakacode · Jun 18, 2024 · b0b18ab · b0b18ab
1 parent ab84ed5
commit b0b18ab
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ ubuntu-latest, macOS-latest, windows-latest ]
+        os: [ ubuntu-latest, macOS-latest ] # windows build is broken, see the note in README
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2

diff --git a/README.md b/README.md
@@ -19,6 +19,9 @@ See [docs.rs/steward](https://docs.rs/steward).
 See [`examples`](./examples).
 
 ## Limitations
+### Windows
+Apparently, Windows build is broken on recent versions of Rust due to [`winapi`](https://github.com/retep998/winapi-rs) being unmaintained. We need to migrate to [`windows-rs`](https://github.com/microsoft/windows-rs), but I don't know anything about Windows, so help is very welcome!
+
 ### Async runtimes
 Tokio only.
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -78,6 +78,12 @@
 //! ```
 //!
 //! ## Limitations
+//! ### Windows
+//! Apparently, Windows build is broken on recent versions of Rust due to
+//! [`winapi`](https://github.com/retep998/winapi-rs) being unmaintained.
+//! We need to migrate to [`windows-rs`](https://github.com/microsoft/windows-rs),
+//! but I don't know anything about Windows, so help is very welcome!
+//!
 //! ### Async runtimes
 //! Tokio only.