Skip to content

docs(README.md): actually remove example with authz issue this time - #1102

Merged
msample merged 1 commit into
mainfrom
mike/docs-readme-again
Jul 30, 2026
Merged

docs(README.md): actually remove example with authz issue this time#1102
msample merged 1 commit into
mainfrom
mike/docs-readme-again

Conversation

@msample

@msample msample commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary

Removed first getting started example due to authz problems

Testing

Renders correctly in my editor's markdown mode

Checklist

  • Docs updated if behavior changed
  • BREAKING CHANGE: footer present if this is a breaking change

Note

Remove GitHub App example with authz issue from README

Replaces the GitHub App-based setup flow in README.md with a credential-free workflow that uses a fine-grained GitHub PAT stored in the macOS keychain, revealed only after the agent exits. Also updates a comment in the command block to note that agents can add build/runtime dependencies via min add.

Macroscope summarized dcb361b.

Summary by CodeRabbit

  • Documentation
    • Updated the “Create a new project with Minimal” workflow to use a fine-grained GitHub personal access token stored securely in the macOS keychain.
    • Clarified that credentials remain unavailable inside the sandbox until the agent exits.
    • Added guidance on installing build and runtime dependencies from the registry with min add.

@msample
msample requested a review from a team as a code owner July 30, 2026 01:52
@msample
msample requested a review from jtnkminimal July 30, 2026 01:53
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README.md updates the Claude Code project workflow to describe fine-grained PAT handling through the macOS keychain, credential isolation inside the sandbox, and dependency installation via min add.

Changes

Credential-free agent workflow

Layer / File(s) Summary
Sandboxed credential and dependency workflow
README.md
Updates Claude Code workflow instructions to use a fine-grained GitHub PAT revealed after agent exit, clarifies that the sandbox has no credentials, and documents registry dependency installation through min add.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Suggested reviewers: twitchyliquid64

Poem

I’m a bunny guarding the key,
PAT tucked where the sandbox can’t see.
Claude hops out, credentials appear,
Dependencies grow with min add near.
Safe little steps, clear as can be!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly points to the README docs change and the removal of the authz-problematic example.
Description check ✅ Passed The description includes Summary, Testing, and Checklist sections and is sufficiently specific for the README-only change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mike/docs-readme-again

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

75-75: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Clarify what remains credential-free.

The workflow is not entirely credential-free because the PAT is later exposed to the sandbox. Consider saying “the agent process remains credential-free” to make the security boundary precise and avoid overstating the guarantee.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 75, Update the README example’s security description to
clarify that the agent process remains credential-free, rather than implying the
entire workflow or sandbox never receives credentials; preserve the explanation
that the PAT is exposed to the sandbox only after the agent exits.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 75: Update the README example’s PAT setup description to explicitly
require the fine-grained token’s repository permission “Contents: Read and
write,” in addition to repository-scoped access, so the later repository update
step is authorized.

---

Nitpick comments:
In `@README.md`:
- Line 75: Update the README example’s security description to clarify that the
agent process remains credential-free, rather than implying the entire workflow
or sandbox never receives credentials; preserve the explanation that the PAT is
exposed to the sandbox only after the agent exits.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 682987f6-30d4-4157-ae0e-d38ec1a6f46c

📥 Commits

Reviewing files that changed from the base of the PR and between d354959 and dcb361b.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
```

Prefer not to grant Claude Code access to your GitHub repos via the Claude GitHub App? This variant keeps the agent credential-free: it uses a fine-grained GitHub personal access token (PAT) stored in the macOS keychain, revealed to the sandbox only after the agent has exited.
In this example we'll create a new git repo from within a Minimal sandbox, using tools from the [Minimal Public Registry](https://github.com/gominimal/pkgs/). The workflow keeps the agent credential-free: it uses a fine-grained GitHub personal access token (PAT) stored in the macOS keychain, revealed to the sandbox only after the agent has exited.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Document the required repository write permission for the PAT.

The fine-grained PAT needs Contents: Read and write; repository-scoped access alone will make the later update step fail with authorization errors.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 75, Update the README example’s PAT setup description to
explicitly require the fine-grained token’s repository permission “Contents:
Read and write,” in addition to repository-scoped access, so the later
repository update step is authorized.

@msample
msample merged commit 063d478 into main Jul 30, 2026
30 checks passed
@msample
msample deleted the mike/docs-readme-again branch July 30, 2026 02:21
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.

4 participants