Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .claude/skills/release/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ disable-model-invocation: true
## Steps
1. Pick the version (SemVer) from the changes since the last tag: `git describe --tags --abbrev=0`, `git log <tag>..HEAD --oneline`.
2. Bump:
- `npm version X.Y.Z --no-git-tag-version` (package.json + package-lock.json)
- `pnpm version X.Y.Z --no-git-tag-version` (package.json)
- `"version"` in `src-tauri/tauri.conf.json`
- `version` under `[workspace.package]` in `Cargo.toml`, then `cargo update --workspace` (Cargo.lock)
3. Add `## [X.Y.Z] — YYYY-MM-DD` at the top of `CHANGELOG.md` (Added / Changed / Fixed, user-facing words).
4. Check locally (Windows): `npm ci`, `npm run build`, `npm test`, `cargo fmt --all -- --check`, `cargo clippy --workspace --all-targets -- -D warnings`, `cargo test --locked -p hmw-core -- --test-threads=1`. Report each command with its exit code.
4. Check locally (Windows): `pnpm install --frozen-lockfile`, `pnpm build`, `pnpm test`, `cargo fmt --all -- --check`, `cargo clippy --workspace --all-targets -- -D warnings`, `cargo test --locked -p hmw-core -- --test-threads=1`. Report each command with its exit code.
5. Commit `Prepare X.Y.Z release`, merge to `main` through a PR, then push the tag: `git tag vX.Y.Z <merge commit>` and `git push origin vX.Y.Z` (or push a `release/vX.Y.Z` branch when tags can't be pushed).
6. Watch it: `gh run watch $(gh run list -w release.yml -L 1 --json databaseId -q '.[0].databaseId')`. All three installers (x64, x86, ARM64) must pass before the release is published. Give the run URL as proof.
9 changes: 6 additions & 3 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,12 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4

- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- uses: dtolnay/rust-toolchain@stable
with:
Expand All @@ -29,13 +32,13 @@ jobs:
workspaces: ". -> target"

- name: Install frontend deps
run: npm ci
run: pnpm install --frozen-lockfile

- name: Build frontend
run: npm run build
run: pnpm build

- name: Test frontend
run: npm test
run: pnpm test

- name: Build payload (x64)
shell: bash
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,13 @@ jobs:
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4

- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm

- name: Set up Rust
uses: dtolnay/rust-toolchain@stable
Expand All @@ -95,7 +98,7 @@ jobs:
key: ${{ matrix.target }}

- name: Install frontend dependencies
run: npm ci
run: pnpm install --frozen-lockfile

- name: Build the injected payload (${{ matrix.arch }})
shell: bash
Expand All @@ -118,7 +121,7 @@ jobs:
uses: tauri-apps/tauri-action@v0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Minisign key from `npm run tauri signer generate` (never commit the private key).
# Minisign key from `pnpm tauri signer generate` (never commit the private key).
# Without both secrets the release has no latest.json, so in-app updates cannot install.
TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ node_modules/
dist/
*.log
npm-debug.log*
pnpm-debug.log*

# Rust / Tauri
target/
Expand Down
8 changes: 4 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
HideMyWindows: a Windows-only desktop app (Tauri 2, Rust core, Svelte 5 UI) that hides windows from screen capture, screenshots and recordings. It sets display affinity directly for its own windows and injects a small DLL into other processes for theirs. `README.md`, `BUILDING.md`, `ARCHITECTURE.md` and `CONTRIBUTING.md` hold the details.

## Setup
- Rust (stable), Node.js and npm, MSVC C++ Build Tools, WebView2 (see `BUILDING.md`).
- `npm install` (CI uses `npm ci`).
- Rust (stable), Node.js and pnpm, MSVC C++ Build Tools, WebView2 (see `BUILDING.md`).
- `pnpm install` (CI uses `pnpm install --frozen-lockfile`).
- Build the payload DLL before running the app, then copy it to `src-tauri/resources/`:
`cargo build -p hmw-payload --profile payload --target x86_64-pc-windows-msvc` and copy `target\x86_64-pc-windows-msvc\payload\hmw_payload.dll` to `src-tauri\resources\hmw_payload.dll`.
- The x64 app also needs the x86 helper and payload (`hmw-release-x86.exe`, `hmw_payload_x86.dll`); the exact commands are in `BUILDING.md` and `.github/workflows/check.yml`.

## Commands
- `npm run tauri dev`: hot-reloading dev build. `npm run tauri build`: release build and installer (under `src-tauri/target/release/bundle/`).
- `npm run build`: frontend build. `npm test`: Vitest.
- `pnpm tauri dev`: hot-reloading dev build. `pnpm tauri build`: release build and installer (under `src-tauri/target/release/bundle/`).
- `pnpm build`: frontend build. `pnpm test`: Vitest.
- `cargo test --locked -p hmw-core -- --test-threads=1`: core tests (run on Windows).
- `cargo fmt --all -- --check` and `cargo clippy --workspace --all-targets -- -D warnings`: must be clean.

Expand Down
10 changes: 5 additions & 5 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ frontend. These steps build it on **Windows** (the only supported runtime OS).
## Prerequisites

- **Rust** (stable) — <https://rustup.rs>
- **Node.js** 18+ and npm
- **Node.js** 18+ and pnpm
- **Microsoft C++ Build Tools** (MSVC) + the **WebView2 runtime** (preinstalled
on Windows 10/11). Tauri's prerequisites guide covers these:
<https://tauri.app/start/prerequisites/>

## 1. Install dependencies

```bash
npm install
pnpm install
```

## 2. Build the injected payload
Expand Down Expand Up @@ -57,10 +57,10 @@ ensures the helper exits with the controller.

```bash
# Hot-reloading dev build
npm run tauri dev
pnpm tauri dev

# Release build + installer (output under src-tauri/target/release/bundle/)
npm run tauri build
pnpm tauri build
```

The installer lands in `src-tauri/target/release/bundle/nsis/`.
Expand All @@ -77,7 +77,7 @@ connection that can create branches but cannot push tags. You do not need every
toolchain locally.

Installed copies check that release for updates. Signing uses a minisign key
generated with `npm run tauri signer generate` and kept outside the repo. The
generated with `pnpm tauri signer generate` and kept outside the repo. The
public key lives in `src-tauri/tauri.conf.json`. The private key and its
password are GitHub Actions secrets named `TAURI_SIGNING_PRIVATE_KEY` and
`TAURI_SIGNING_PRIVATE_KEY_PASSWORD`. A release built without those secrets
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ are very welcome.
## Commit / PR

- One logical change per PR, with a clear description.
- Make sure `cargo build` (on Windows) and `npm run build` succeed.
- Make sure `cargo build` (on Windows) and `pnpm build` succeed.
- By contributing, you agree your work is licensed under the project's
MIT + Commons Clause license.
Loading
Loading