golem icon indicating copy to clipboard operation
golem copied to clipboard

Provide Golem Native Development on Windows

Open laz-001 opened this issue 8 months ago • 0 comments

Subtasks & Sequence

  • [x] Basics, ci-draft PoC
    • [x] Requirements Analysis (see below)
    • [x] General Doc Update: https://github.com/golemcloud/golem/pull/1651
    • [X] Create a github runner that executes the testsuites (validation and tests)
      • [X] exclude any crashing tests, so the test-runs finalize, reporting the errors
    • [x] https://github.com/golemcloud/golem/pull/1658 (win-ci, github free-tier)
      • iteration time: ~30min. - but no dependency to payed runners
  • [ ] Validate build/test on local low/mid-end Win10 machine (ci != local)
    • [X] JUNIT_OPTS issue
    • [X] sqlite deletion (used semi-workaround after 1 workday to avoid delays)
    • [ ] missing precompiled binaries
    • [ ] several issues, incl. crashes
  • [ ] Prepare existent ci-run (ci.yaml) to get windows added
    • [ ] https://github.com/golemcloud/golem/pull/1655 (keep personal/local dev-tools out of git)
    • [ ] https://github.com/golemcloud/golem/pull/1654
    • [ ] https://github.com/golemcloud/golem/pull/1656
  • [ ] Fix the crashes / errors
    • [ ] This potentially needs fixes in non-golem code (wasmtime, sozu-proxy & poule, etc.)

Original Issue

  • https://github.com/golemcloud/golem/issues/1210

Goal

"enhance Golem and its dependencies so that developers who are using Windows may have a first-class development experience, without having to install Windows Subsystem for Linux (WSL)."

Feasibility Analysis

  • Feasible
  • Slightly(!) changed requirements

Requirements

  • Require no more setup for development than on Linux or Mac
    • IMPORTANT: golem linux/mac requires Docker, for the test-runs
    • Provide a Prerequisites section for Windows
      • currently empty (same as for linux)
    • if there are many *.sh scripts, the git-bash shell can be added to the prerequisites.
      • "Install Git for Windows" => includes git bash
      • try to avoid the need for git bash
  • the main cli build instructions are quasi the same as on linux/mac
  • the main cli test instructions are quasi the same (see Contributing.md)
  • tests pass, and in conclusion:
    • All Golem binaries (including single executable) run without issue on Windows
  • Gihub actions CI passes on windows runner

laz-001 avatar May 23 '25 07:05 laz-001