Skip to content

Windows Testing and Support #14

@LeeSinLiang

Description

@LeeSinLiang

Windows testing & support (hooks + docs + CI)

Summary
Ensure CommitLM works smoothly on Windows (PowerShell/CMD), including hook installation/execution, CRLF handling, and quick-start docs. Add a minimal Windows CI smoke test.

Motivation
Reducing setup friction in Windows increases adoption and contribution success.

Scope

  • Detect Windows during commitlm install-hook and install PowerShell/CMD-friendly hooks (shebang/exec bit considerations, CRLF-safe wrappers).
  • Add README “Windows setup” block (PowerShell policy note, venv activation, sample workflow).
  • Add GitHub Actions job (windows-latest) that runs a smoke test: init a temp repo, install hooks, create a dummy change, run git commit, confirm docs file created.

Out of scope
WSL-specific optimizations.

Tasks

  • Update hook installer to generate .ps1 / .cmd wrappers on Windows.
  • Normalize line endings and document git config core.autocrlf recommendations.
  • Add README Windows section with exact commands.
  • Add windows job to CI with the smoke test above.

Acceptance criteria

  • Hooks install and run successfully on Win 11 + Git for Windows (CI proves it).
  • README contains a concise Windows quick-start.
  • No crash when default shell is PowerShell or CMD.

Test plan

  1. commitlm init && commitlm install-hook on Windows.
  2. echo "x" > demo.txt && git add . && git commit -m "chore: test" → docs file appears under docs/.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions