docs: document deferred values and credentials as targets - #109
Merged
Merged
Conversation
hephbuild/heph#458 added ${src://pkg:name} — the sandbox path of another target's output — alongside the existing ${read://pkg:name} contents form. Neither was documented on the site; add a Deferred values concept page and cross-link it from the exec/bash driver docs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JVc3xVtpWa7kPVKKweR5Dc
cp's destination argument didn't match the declared out path. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JVc3xVtpWa7kPVKKweR5Dc
⚡ Cloudflare Pages preview
|
hephbuild/heph#455 introduced the credential driver, hephbuild/heph#456 the underlying deferred-values mechanism it and #458's ${src://…} both build on. Only the deferred-values half was covered so far; add a Credentials concept page covering the driver, source chain, when vocabulary, presentation shapes and presets, the CLI, and redaction — sourced from heph's docs/CREDENTIALS.md and the plugincredential builtins on master. Cross-link it from the deferred-values page, which already noted a credential's present block as a consumer. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JVc3xVtpWa7kPVKKweR5Dc
raphaelvigee
changed the title
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
2 participants
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
Covers the last three commits on
hephbuild/hephmaster, which landed together as one feature train:4ba6266) —credentialas a target driver.780af6f) — the deferred-values mechanism (${read://pkg:name}) a driver option reads from another target, which credentials build on top of.d21817d) —${src://pkg:name}, the sandbox-path form of a deferred value.None of this was documented on the site before this PR.
website/docs/concepts/deferred-values.md): the two forms (${read://…}/${src://…}), the output-group selector, where an option can/can't accept one, failure behavior, and the substitution-not-quoting caveat forbash.website/docs/concepts/credentials.md): thecredentialdriver and its contract (never hashed, never an input), the source chain andwhenvocabulary, the three presentation shapes and theheph.auth.*presentation presets (AWS/GCP/Azure/GitHub/Docker/git/netrc), consuming a credential withcredentials = [...], theheph authCLI, and log redaction. Cross-links to Deferred values, since a credential'spresentvalues accept${read://…}(e.g.role = "${read://infra/aws:role-arn}").website/sidebars.ts, under "Concepts".website/docs/plugins/exec.md(run's config-key row plus a short section), sincerunis the only currently-documented driver option outside credentials that accepts one.copy-versionexample'srunwrote to a different filename than its declaredout— thanks for catching that.Content is sourced directly from
hephbuild/heph'sdocs/DEFERRED_VALUES.md,docs/CREDENTIALS.md,example/deferred/,example/credential/, and theplugincredential/core::templatesource onmaster(I read the actual Starlark builtin definitions to get exact function signatures —heph.auth.oidc,heph.auth.exec, the presentation presets, etc. — rather than guessing from the prose docs alone), rewritten in the site's user-facing style (no internal architecture/hashing/security-boundary mechanics, no source-code paths in the rendered text).Not built locally (no build environment available in this session) — content-only change, both pages registered in
sidebars.tsper the checklist in.claude/writing-docs.md.Test plan
lint(ESLint, zero warnings)build(Docusaurus production build)execpage render correctly, and both sidebar entries appear under "Concepts"🤖 Generated with Claude Code
https://claude.ai/code/session_01JVc3xVtpWa7kPVKKweR5Dc