ci: documentation-boundary rule; capture .env-deploys-to-fabric - #59
Merged
Conversation
…fabric fact Two related tunings driven by the #55 review rounds: 1. Establish a general "defer to Harper docs" rule for app/plugin/sample repos. Harper maintains authoritative docs at docs.harperdb.io covering core, pro, and fabric; repo docs that re-explain those mechanics drift out of sync when Harper updates. New section in harper/common.md tells reviewers to flag re-explanations; matching sections in claude-mention.yml and claude-issue-to-pr.yml prompts tell the authoring agent to prefer links over re-explanations. 2. Capture ".env at app root deploys with the component" in harper/v5.md. This is the fact the last review round needed but didn't have — the reviewer correctly flagged that a GitHub Actions env: block doesn't propagate to Fabric runtime, but without the ".env deploys" mechanism documented, the fix path was unclear. Also clarifies deploy credentials vs runtime secrets so future reviews don't have to re-derive the distinction. The documentation-boundary rule is written reviewer-facing (review-scope) and author-facing (workflow prompts) in parallel — same principle, two audiences. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
No blockers found. What I traced
|
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
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
Two related tunings driven by the #55 review rounds (the env-vars docs PR that went through multiple iterations of "re-explain Harper mechanics vs point at Harper docs").
1. Documentation-boundary rule
Harper maintains authoritative docs at docs.harperdb.io covering core, pro, and fabric. App/plugin/sample repos should:
Re-explaining Harper mechanics in repo docs creates drift — Harper updates its docs, the repo's copy doesn't.
Applied in parallel:
.github/review-scopes/harper/common.md— reviewer-facing: flag PRs that re-explain instead of link.github/workflows/claude-mention.yml+.github/workflows/claude-issue-to-pr.yml— author-facing: same principle for agents writing or revising docs2. Capture
.env-deploys-to-fabric factThe last review round on #55 correctly flagged that a GitHub Actions
env:block doesn't propagate to Fabric runtime, but left the path forward ambiguous because the actual mechanism (.envat app root is deployed alongside the component) wasn't in any layer. Adding it toharper/v5.mdunder Environment variables, plus a clarifying bullet on deploy credentials vs runtime secrets so future reviews don't re-derive the distinction.Test plan
common.mdrule and picks up the.env-deploys-to-fabric contextHarperFast/skillsrule for customer-facing authoring guidance — I'll draft a separate PR for that after this lands.🤖 Generated with Claude Code