Skip to content

docs: heph.core.num_cpu/packages, heph.fs.parent, in_place vs copy guard#60

Open
raphaelvigee wants to merge 1 commit into
mainfrom
claude/laughing-lovelace-qcab2r
Open

docs: heph.core.num_cpu/packages, heph.fs.parent, in_place vs copy guard#60
raphaelvigee wants to merge 1 commit into
mainfrom
claude/laughing-lovelace-qcab2r

Conversation

@raphaelvigee

Copy link
Copy Markdown
Member

What

Documents the user-facing additions from hephbuild/heph#144 (commit 34dc78d):

  • heph.core.num_cpu() — CPUs available to the process. Added a row to the heph.core table plus a usage example in website/docs/plugins/buildfile.md.
  • heph.core.packages(matcher) — sorted list of workspace package paths matching a query matcher string, evaluated per package (package-level matchers only; target-level matchers error). Documented alongside num_cpu() in the same page.
  • heph.fs.parent(filename) — walks up from the current package to the workspace root and returns the workspace-root-relative path of the closest filename, or None. Added a row + example + note (bare filename only) to website/docs/plugins/fs.md.
  • codegen = "in_place" guard — an in_place target no longer clobbers a tree file owned by a codegen = "copy" target; --frozen skips the same files symmetrically. Added a :::note to the in_place section of website/docs/concepts/codegen.md.

Per the reference-drift rule in CLAUDE.md, also updated the heph-expert skill reference twins:

  • plugins/heph-expert/skills/heph/references/authoring.md (heph.core / heph.fs tables)
  • plugins/heph-expert/skills/heph/references/concepts.md (codegen in_place vs copy ownership)

No new pages, so no sidebars.ts changes. Did not touch website/docs/reference/cli.md (generated) or the go plugin docs (unchanged per the PR — an earlier go_compile_src addition was reverted before merge).

Test plan

  • lint — not run in this session (no build env available here); please verify in CI.
  • build — not run in this session; please verify in CI.
  • Verified new function behavior against the heph repo source (crates/builtins/src/pluginfs/mod.rs, crates/plugin-buildfile/src/pluginbuildfile/run_file.rs, crates/engine/src/engine/result.rs) rather than the PR description alone.

🤖 Generated with Claude Code


Generated by Claude Code

Reflects hephbuild/heph#144 (commit 34dc78d930407611473721c736a3a1f8bb8576e0):
- heph.core.num_cpu() and heph.core.packages(matcher) builtins
- heph.fs.parent(filename) provider function
- codegen=in_place no longer clobbers a file owned by a codegen=copy target

Updates both the docs pages and their heph-expert skill reference twins per
the reference-drift rule.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015xfeKHdizRWuQczcGrQgHA
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

⚡ Cloudflare Pages preview

Preview https://3d5eb89e.hephbuild.pages.dev
Commit f2f83dd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants