Skip to content

docs(ci): document the runtime-path fixture in the macOS adapter lane - #2312

Merged
Alan-TheGentleman merged 1 commit into
mainfrom
docs/ci-macos-path-fixture
Nov 9, 2026
Merged

Alan-TheGentleman merged 1 commit into
mainfrom
docs/ci-macos-path-fixture

Conversation

@Alan-TheGentleman

@Alan-TheGentleman Alan-TheGentleman commented Nov 6, 2026 •

Copy link
Copy Markdown
Collaborator

Problem and result

The macOS adapter guide describes only the prebuilt Pi server and still says the runtime/PATH fixture is not integrated. The workflow already prebuilds both existing fixtures and exports both paths after sanitizing the environment.

Update only docs/ci-macos.md to show both build commands, the Pi test environment and the current integration boundary. No workflow, fixture, dependency, timeout or runtime changes.

Linked issue (required)

Closes #2341

The merged runtime-fixture implementation is context, not the issue reference for this documentation correction. The accepted documentation scope and checks are recorded in #2341, approved and assigned to dnlrsls.

Verification

Unchanged source candidate: a25383c776f9deb76bbc1896b72ee50a3512b9eb. Compared against current canonical main 5cde7fd6dd69add08fd8f458fdf822c7828d8609.

  • Direct source comparison confirms both prebuild commands and the two post-isolation environment exports in .github/workflows/ci.yml.
  • node --test .github/scripts/ci-technical-contracts.test.mjs — PASS, 47 tests, zero failures/skips, 8.844s on Windows/Node24.
  • Both referenced fixture source paths and the document's local link resolve; all four Bash blocks parse with bash -n.
  • git diff --check origin/main...HEAD — PASS; only one documentation file differs (8 additions/3 deletions).
  • Go runtime tests: N/A — documentation-only; no Go behavior changed. No native macOS execution is claimed.

The original author and source commit are preserved. Fresh issue-policy validation is required for this metadata correction; hosted checks are not assumed green before they run.

The macOS adapter step now prebuilds both Pi fixtures (pi-test-server and pi-test-path from the merged runtime-contract work) and exports ENGRAM_PI_TEST_PATH_BINARY alongside the server binary after the env-isolation loop, so sanitization cannot strip it; the doc replaces the stale claim about #1906 work being copied with the actual prebuild from repository source.
Copilot AI balanced review requested due to automatic review settings November 6, 2026 19:43
@Alan-TheGentleman Alan-TheGentleman added the type:docs Documentation only label Nov 6, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@coderabbitai

coderabbitai Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The macOS adapter lane documentation now covers building the Pi test server and runtime-path binary from repository source. It also documents how the test command receives both binary paths and clarifies which fixture and PATH work is included.

Changes: macOS adapter lane

Layer / File(s) Summary
Build and pass prebuilt fixtures
docs/ci-macos.md
The setup builds the Pi test server and runtime-path binary. The test command supplies both paths after environment sanitization. The documentation identifies the merged #1906 path fixture and states that no other fixture or PATH work is included.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related issues

  • Issue 1903 — It covers Pi PATH and HTTP integration tests with prebuilt fixtures. This change documents the macOS lane’s fixture setup, while stating that no other fixture or PATH work is included.

Possibly related PRs

Suggested labels: type:chore

Suggested reviewers: gentleman-programming

Merge Risk: Minimal · up to a2538

The documentation describes the prebuilt fixture workflow. No actionable merge-blocking risk was identified.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the documentation update for the runtime-path fixture in the macOS adapter lane.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between cb02c5d and a25383c.

Files selected for processing: 1

  • docs/ci-macos.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@dnlrsls dnlrsls left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the exact unchanged docs candidate against current main 5cde7fd. Both prebuilt fixture commands and exports after environment isolation match the workflow. All 47 CI contract tests passed on Windows/Node24; local link/source-path checks, four Bash syntax checks and diff checks passed. No native macOS execution is inferred. The new docs-only issue #2341 is approved and assigned, and fresh reference/approval/type checks passed after correcting the PR metadata. No source changes or merge performed.

Merged via the queue into main with commit b53422f Nov 9, 2026
48 of 59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(ci): align macOS adapter guide with both prebuilt Pi fixtures

3 participants