docs(exec): document group-name sanitization for SRC_/OUT_/TOOL_ env vars#58
Merged
Merged
Conversation
…vars heph/heph#141 fixed a bug where dep-map, out, and tools group names containing `.`, `-`, `/`, etc. produced invalid (non-POSIX) env var names. Document the actual sanitization rule so users know exactly what env var name a group name maps to.
⚡ Cloudflare Pages preview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
hephbuild/heph#141 fixed a bug where
deps/out/toolsgroup names containing characters outside[A-Za-z0-9_](e.g..,-,/) produced invalid, non-POSIX environment variable names (SRC_MY-GROUP), which shells reject or silently drop — so the dependency never reached the sandbox. The fix uppercases the group name and replaces any character outside[A-Z0-9_]with_.This changes what a user should expect their
SRC_<group>/OUT_<group>/TOOL_<group>env var to be named, so the docs need to state the actual rule rather than implying a plain.to_uppercase().website/docs/plugins/exec.md(Dependencies section) documenting the sanitization rule, with an example (my-group→$SRC_MY_GROUP).plugins/heph-expert/skills/heph/references/authoring.md(Dependency kinds section), per the reference-drift rule in this repo's CLAUDE.md.Test plan
exec.md.Refs: hephbuild/heph#141 (fix(plugin-exec): sanitize dep-map group names into valid env vars)
Generated by Claude Code