Skip to content

docs: add FAQ item about bun install on GHES #913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peloyeje wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add FAQ item about bun install on GHES #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,4 +370,6 @@ Use `path_to_bun_executable` to provide your own Bun runtime instead of the defa
# ... other inputs
```

> **Note for GHES users**: The automatic Bun installation requires authenticated access to github.com to avoid rate limits. On GitHub Enterprise Server, you'll need to either provide a github.com PAT to `setup-bun` or use `path_to_bun_executable`. See the [FAQ](faq.md#how-do-i-fix-bun-installation-issues-on-github-enterprise-server-ghes) for setup instructions.

**Important**: Using incompatible versions may cause the action to fail. Ensure your custom executables are compatible with the action's requirements.
26 changes: 26 additions & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,32 @@ However, tools from these servers still need to be explicitly allowed via `claud

## Troubleshooting

### How do I fix Bun installation issues on GitHub Enterprise Server (GHES)?

The `setup-bun` action requires authenticated access to github.com to avoid rate limits when fetching Bun releases.
On GHES, we recommend installing Bun externally and providing the path to the executable:

```yaml
steps:
# Install Bun using the official installer
- name: Install Bun
run: |
curl -fsSL https://bun.sh/install | bash
echo "$HOME/.bun/bin" >> $GITHUB_PATH
# ... or with setup-bun and a github.com token
- name: Install Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.3.6
token: # PAT with public_repo scope for github.com

# Use the action with custom Bun path
- uses: anthropics/claude-code-action@v1
with:
path_to_bun_executable: "$HOME/.bun/bin/bun"
# ... other inputs
```

### How can I debug what Claude is doing?

Check the GitHub Action log for Claude's run for the full execution trace.
Expand Down