Skip to content

Commit f4369a6

Browse files
author
Jean-Eudes Peloye
committed
docs: add FAQ item about bun install on GHES
1 parent d5b01b6 commit f4369a6

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

action.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ runs:
159159
uses: oven-sh/setup-bun@3d267786b128fe76c2f16a390aa2448b815359f3 # https://github.com/oven-sh/setup-bun/releases/tag/v2.1.2
160160
with:
161161
bun-version: 1.3.6
162-
token: ${{ inputs.github_token || github.token }}
163162

164163
- name: Setup Custom Bun Path
165164
if: inputs.path_to_bun_executable != ''

docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,4 +375,6 @@ Use `path_to_bun_executable` to provide your own Bun runtime instead of the defa
375375
# ... other inputs
376376
```
377377

378+
> **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-use-this-action-on-github-enterprise-server-ghes) for setup instructions.
379+
378380
**Important**: Using incompatible versions may cause the action to fail. Ensure your custom executables are compatible with the action's requirements.

docs/faq.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,32 @@ However, tools from these servers still need to be explicitly allowed via `claud
205205

206206
## Troubleshooting
207207

208+
### How do I fix Bun installation issues on GitHub Enterprise Server (GHES)?
209+
210+
The `setup-bun` action requires authenticated access to github.com to avoid rate limits when fetching Bun releases.
211+
On GHES, we recommend installing Bun externally and providing the path to the executable:
212+
213+
```yaml
214+
steps:
215+
# Install Bun using the official installer
216+
- name: Install Bun
217+
run: |
218+
curl -fsSL https://bun.sh/install | bash
219+
echo "$HOME/.bun/bin" >> $GITHUB_PATH
220+
# ... or with setup-bun and a github.com token
221+
- name: Install Bun
222+
uses: oven-sh/setup-bun@v2
223+
with:
224+
bun-version: 1.3.6
225+
token: # PAT with public_repo scope for github.com
226+
227+
# Use the action with custom Bun path
228+
- uses: anthropics/claude-code-action@v1
229+
with:
230+
path_to_bun_executable: "$HOME/.bun/bin/bun"
231+
# ... other inputs
232+
```
233+
208234
### How can I debug what Claude is doing?
209235

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

0 commit comments

Comments
 (0)