[PR #5039] docs(windows): clarify native artifact restore and cleanup in source … #6752

Open
opened 2026-11-01 21:42:48 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5039
Author: @kaushikrawal4365
Created: 10/18/2026
Status: 🔄 Open

Base: main ← Head: docs/windows-native-restore-guidance


📝 Commits (4)

  • 215de8d docs(windows): clarify native artifact restore and cleanup in source checkout
  • 0aecef6 docs(windows): name archive exactly in PowerShell cleanup
  • bb9738b docs(windows): isolate native restore extraction in temporary directory
  • bf84ee4 docs(windows): verify registry integrity and link recovery in contributing

📊 Changes

2 files changed (+35 additions, -8 deletions)

View changed files

📝 CONTRIBUTING.md (+5 -3)
📝 native/windows/README.md (+30 -5)

📄 Description

Summary

Clarifies Windows native artifact restore steps in native/windows/README.md by providing both PowerShell and POSIX shell commands, extracting into an isolated temporary folder to avoid deleting existing files, cleaning up named files, and validating the restored artifact with npm run verify:windows-native:artifact.

No issue; found while setting up a Windows checkout.

Problem and expected behavior

The previous documentation only provided POSIX shell commands that unpacked the entire published tarball and did not clean up temporary extraction files. Additionally, deleting package recursively could delete an existing unrelated package/ folder in the checkout root.

The updated documentation provides:

  • Exact commands for PowerShell (Windows 10+) and POSIX shells (Git Bash / WSL).
  • Safe extraction into an isolated temporary directory .tmp-restore with tar -C.
  • Targeted extraction of package/native/windows/build to avoid unpacking unrelated files.
  • Cleanup of only the temporary extraction directory and exact versioned tarball.
  • An explicit verification step using npm run verify:windows-native:artifact.

Change and scope

Follow the contribution scope.
Unresolved scope, authority, side effects, or required verification block
integration. Link the required maintainer scope decision for new providers or
capabilities involving target execution, injection, mutation, or protection
recovery; ordinary fixes within existing boundaries may state "not applicable".
Draft PRs may leave the scope decision pending and the readiness and merge checklists
unchecked. Maintainers can help resolve open questions.

Documentation only. No new capabilities or behavioral changes.

Contract and boundary impact

  • Semantic owner and earliest changed stage: Documentation (native/windows/README.md)
  • Contribution scope fit and linked maintainer decision: not applicable (documentation only)
  • CLI and MCP/tool-catalog contract: none
  • Provider, bridge, target-format, or platform compatibility: Windows native module restore documentation
  • Evidence, artifact, provenance, or reconstruction contract: none
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact (CI generates and validates ignored catalogs and skills/; edit authored instructions in .agents/skills/reverse-engineer-anything/ and never commit build outputs): none

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none (documentation only)
  • Base reproduction or other evidence: Verified extraction and cleanup steps in PowerShell on Windows 11 x64 and verified artifact validity
  • User-visible CLI/MCP output (if applicable): none
  • Remaining proof gaps: none

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • npm run verify:windows-native:artifact — passes: restores manifest.json and rea-windows-x64.node and matches checksum/PE
  • npm run docs:check — passes (6 tasks cached/successful, conformance tests passed)
  • npm run check:fast — passes (typecheck, lint)
  • npm run format:check — passes (all 4032 files matched correct format)

Compatibility, safety, and release

  • Breaking changes or migration steps: none
  • Real Hopper/Ghidra, browser, or OS coverage: Windows 11 x64
  • Package or release metadata impact: none
  • Security, privacy, process, or containment review: avoids deleting existing package/ directory by extracting into an isolated temporary folder

Author readiness

Human owner: @kaushikrawal4365

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • The PR has one focused outcome and the title follows type(scope): outcome.
  • Related issue is linked, or the reason for not linking one is stated above.
  • Tests cover changed observable behavior and meaningful failure paths.
  • Owning docs, contracts, and generated metadata are updated where needed.
  • User-visible CLI/MCP changes include representative output.
  • I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/5039 **Author:** [@kaushikrawal4365](https://github.com/kaushikrawal4365) **Created:** 10/18/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/windows-native-restore-guidance` --- ### 📝 Commits (4) - [`215de8d`](https://github.com/morluto/rea/commit/215de8d395aac62ea9f8ef564170bd04c7032d71) docs(windows): clarify native artifact restore and cleanup in source checkout - [`0aecef6`](https://github.com/morluto/rea/commit/0aecef6685a8fef6547f9a4c7d03996f043026c1) docs(windows): name archive exactly in PowerShell cleanup - [`bb9738b`](https://github.com/morluto/rea/commit/bb9738bec46042be4b1a30b8262e7f0be5035920) docs(windows): isolate native restore extraction in temporary directory - [`bf84ee4`](https://github.com/morluto/rea/commit/bf84ee41f92695989d29c1e00c5a2e2b9e960346) docs(windows): verify registry integrity and link recovery in contributing ### 📊 Changes **2 files changed** (+35 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+5 -3) 📝 `native/windows/README.md` (+30 -5) </details> ### 📄 Description ## Summary Clarifies Windows native artifact restore steps in `native/windows/README.md` by providing both PowerShell and POSIX shell commands, extracting into an isolated temporary folder to avoid deleting existing files, cleaning up named files, and validating the restored artifact with `npm run verify:windows-native:artifact`. No issue; found while setting up a Windows checkout. ## Problem and expected behavior The previous documentation only provided POSIX shell commands that unpacked the entire published tarball and did not clean up temporary extraction files. Additionally, deleting `package` recursively could delete an existing unrelated `package/` folder in the checkout root. The updated documentation provides: - Exact commands for PowerShell (Windows 10+) and POSIX shells (Git Bash / WSL). - Safe extraction into an isolated temporary directory `.tmp-restore` with `tar -C`. - Targeted extraction of `package/native/windows/build` to avoid unpacking unrelated files. - Cleanup of only the temporary extraction directory and exact versioned tarball. - An explicit verification step using `npm run verify:windows-native:artifact`. ## Change and scope Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Unresolved scope, authority, side effects, or required verification block integration. Link the required maintainer scope decision for new providers or capabilities involving target execution, injection, mutation, or protection recovery; ordinary fixes within existing boundaries may state "not applicable". Draft PRs may leave the scope decision pending and the readiness and merge checklists unchecked. Maintainers can help resolve open questions. Documentation only. No new capabilities or behavioral changes. ## Contract and boundary impact - Semantic owner and earliest changed stage: Documentation (`native/windows/README.md`) - Contribution scope fit and linked maintainer decision: not applicable (documentation only) - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: Windows native module restore documentation - Evidence, artifact, provenance, or reconstruction contract: none - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact (CI generates and validates ignored catalogs and `skills/`; edit authored instructions in `.agents/skills/reverse-engineer-anything/` and never commit build outputs): none Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none (documentation only) - Base reproduction or other evidence: Verified extraction and cleanup steps in PowerShell on Windows 11 x64 and verified artifact validity - User-visible CLI/MCP output (if applicable): none - Remaining proof gaps: none For evidence-bearing changes: - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - `npm run verify:windows-native:artifact` — passes: restores manifest.json and rea-windows-x64.node and matches checksum/PE - `npm run docs:check` — passes (6 tasks cached/successful, conformance tests passed) - `npm run check:fast` — passes (typecheck, lint) - `npm run format:check` — passes (all 4032 files matched correct format) ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: Windows 11 x64 - Package or release metadata impact: none - Security, privacy, process, or containment review: avoids deleting existing package/ directory by extracting into an isolated temporary folder ## Author readiness Human owner: @kaushikrawal4365 - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#6752
No description provided.