fix: support Windows builds and tests

Replace Unix-only hub test fixtures with a cross-platform helper executable. Document Windows installation and usage, and ignore the generated .exe artifact while retaining Linux build guidance.
This commit is contained in:
2026-09-06 19:23:15 +01:00
parent 761424b2d5
commit ca53874b48
3 changed files with 99 additions and 9 deletions
+45 -1
View File
@@ -19,9 +19,29 @@ Stack Sync never runs `git stash`, `git reset`, `git clean`, `git commit`, or an
Stack Sync intentionally preserves `hub sync` semantics. That means `hub` may delete a local branch when its upstream branch has been deleted and it considers the local branch merged. It warns instead when it finds unpushed or apparently unmerged commits. The interactive confirmation calls this out; review `hub help sync` before using `--yes` in automation.
## Requirements
Stack Sync supports Linux and Windows. It requires:
- Go 1.24 or newer to build;
- Git on `PATH`;
- [hub](https://hub.github.com/) on `PATH` for `sync` and `tui` sync operations.
The read-only `scan` command does not require `hub`.
## Build and install
Requires Go 1.24 or newer, Git, and [hub](https://hub.github.com/).
`go install` is the simplest cross-platform installation method. From the repository root, run:
```text
go install .
```
Go automatically installs `stack-sync` on Linux and `stack-sync.exe` on Windows into your Go binary directory. Make sure that directory is on `PATH` (normally `$HOME/go/bin` on Linux and `%USERPROFILE%\go\bin` on Windows).
To build a binary in the repository instead, use the command for your platform.
### Linux
```bash
cd stack-sync
@@ -30,6 +50,18 @@ go build -o stack-sync .
install -Dm755 stack-sync ~/.local/bin/stack-sync
```
### Windows (PowerShell)
```powershell
Set-Location stack-sync
go test ./...
go build -o stack-sync.exe .
New-Item -ItemType Directory -Force "$env:LOCALAPPDATA\Programs\stack-sync" | Out-Null
Copy-Item .\stack-sync.exe "$env:LOCALAPPDATA\Programs\stack-sync\stack-sync.exe"
```
Add `%LOCALAPPDATA%\Programs\stack-sync` to your user `PATH` if it is not already present. The `.exe` suffix is important when choosing an explicit output name on Windows; `go build -o stack-sync .` creates an extensionless binary there.
## Usage
### Interactive TUI
@@ -40,6 +72,12 @@ Launch the control deck for the workspace:
stack-sync tui --root ~/Coding/jwtf
```
PowerShell accepts the same options with a Windows path:
```powershell
stack-sync tui --root C:\Users\you\Coding\jwtf
```
Every eligible repository starts selected. Move with the arrow keys or `j`/`k`, toggle the focused repository with Space, select all with `a`, clear the selection with `n`, and refresh with `r`. Press `s` or Enter to review the destructive-branch warning, then `y` to begin. Blocked repositories cannot be selected and show their first dirty paths in the detail panel. After a run, focusing a repository shows its latest `hub` output.
### CLI and automation
@@ -52,6 +90,10 @@ stack-sync scan --root ~/Coding/jwtf
stack-sync --root ~/Coding/jwtf
```
```powershell
stack-sync scan --root C:\Users\you\Coding\jwtf
```
Review the same plan, confirm it, and sync every eligible repository:
```bash
@@ -74,6 +116,8 @@ Useful options:
--json emit structured output
```
Both `/` and `\` are accepted in Windows paths. Quote a root or exclusion containing spaces, for example `--root "C:\Users\you\Source Repositories"`.
Dependency caches, build outputs, and tool-managed directories such as `node_modules`, `target`, `.claude`, and `.codex` are skipped during discovery by default. These exclusions only affect repository discovery; they never make real changes inside a discovered repository disappear from its dirty-worktree check.
Exit codes are `0` for a successful scan or sync (planned dirty repositories may be safely skipped), `1` for an operational/sync failure, `2` for invalid or unconfirmed non-interactive use, and `3` when strict mode refuses the plan or a previously eligible repository fails its immediate pre-sync safety check.