docs: document project configuration trust model for PR workflows#1336
Open
juniperbevensee wants to merge 1 commit into
Open
docs: document project configuration trust model for PR workflows#1336juniperbevensee wants to merge 1 commit into
juniperbevensee wants to merge 1 commit into
Conversation
The action already restores project-level configuration (.claude/, .mcp.json, etc.) from the PR base branch via restoreConfigFromBase(), but this behavior isn't covered in the user-facing security docs. This adds a section explaining what the action does automatically and how users of claude-code-base-action or direct claude -p invocations can handle project configuration when processing untrusted PR code.
Author
|
Major company fixing this: alibaba/TorchEasyRec#515 |
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
claude-code-actionrestores project-level configuration (.claude/,.mcp.json, etc.) from the PR base branch before Claude runs, and what that protects againstclaude-code-base-actionor directclaude -pinvocations who need to handle project configuration themselves when processing PR codepull_request_targetsection with a complementary section covering hooks and project config more broadlyContext
The action already implements
restoreConfigFromBase()insrc/github/operations/restore-config.ts, which replaces PR-controlled configuration paths with base-branch versions. The source comments describe the threat model clearly, but this behavior isn't covered in the user-facing security docs. Users ofclaude-code-base-actionor rawclaude -phave no equivalent guidance.This addition makes the existing protection visible and gives actionable patterns for workflows that don't use the full action.
Changes
One new section in
docs/security.md("Project-Level Configuration in PR Workflows") with three subsections:claude-code-actionhandles it (base-branch restoration,.claude-pr/preservation)claude-code-base-action/claude -pusers (base-only checkout, manual restoration, or switching to the full action)