|
| 1 | +# Frequently Asked Questions (FAQ) |
| 2 | + |
| 3 | +This FAQ addresses common questions and gotchas when using the Claude Code GitHub Action. |
| 4 | + |
| 5 | +## Triggering and Authentication |
| 6 | + |
| 7 | +### Why doesn't tagging @claude from my automated workflow work? |
| 8 | + |
| 9 | +The `github-actions` user cannot trigger subsequent GitHub Actions workflows. This is a GitHub security feature to prevent infinite loops. To make this work, you need to use a Personal Access Token (PAT) instead, which will act as a regular user, or use a separate app token of your own. When posting a comment on an issue or PR from your workflow, use your PAT instead of the `GITHUB_TOKEN` generated in your workflow. |
| 10 | + |
| 11 | +### Why does Claude say I don't have permission to trigger it? |
| 12 | + |
| 13 | +Only users with **write permissions** to the repository can trigger Claude. This is a security feature to prevent unauthorized use. Make sure the user commenting has at least write access to the repository. |
| 14 | + |
| 15 | +### Why am I getting OIDC authentication errors? |
| 16 | + |
| 17 | +If you're using the default GitHub App authentication, you must add the `id-token: write` permission to your workflow: |
| 18 | + |
| 19 | +```yaml |
| 20 | +permissions: |
| 21 | + contents: read |
| 22 | + id-token: write # Required for OIDC authentication |
| 23 | +``` |
| 24 | +
|
| 25 | +The OIDC token is required in order for the Claude GitHub app to function. If you wish to not use the GitHub app, you can instead provide a `github_token` input to the action for Claude to operate with. See the [Claude Code permissions documentation][perms] for more. |
| 26 | + |
| 27 | +## Claude's Capabilities and Limitations |
| 28 | + |
| 29 | +### Why won't Claude update workflow files when I ask it to? |
| 30 | + |
| 31 | +The GitHub App for Claude doesn't have workflow write access for security reasons. This prevents Claude from modifying CI/CD configurations that could potentially create unintended consequences. This is something we may reconsider in the future. |
| 32 | + |
| 33 | +### Why won't Claude rebase my branch? |
| 34 | + |
| 35 | +By default, Claude only uses commit tools for non-destructive changes to the branch. Claude is configured to: |
| 36 | + |
| 37 | +- Never push to branches other than where it was invoked (either its own branch or the PR branch) |
| 38 | +- Never force push or perform destructive operations |
| 39 | + |
| 40 | +You can grant additional tools via the `allowed_tools` input if needed: |
| 41 | + |
| 42 | +```yaml |
| 43 | +allowed_tools: "Bash(git rebase:*)" # Use with caution |
| 44 | +``` |
| 45 | + |
| 46 | +### Why won't Claude create a pull request? |
| 47 | + |
| 48 | +Claude doesn't create PRs by default. Instead, it pushes commits to a branch and provides a link to a pre-filled PR submission page. This approach ensures your repository's branch protection rules are still adhered to and gives you final control over PR creation. |
| 49 | + |
| 50 | +### Why can't Claude run my tests or see CI results? |
| 51 | + |
| 52 | +Claude cannot access GitHub Actions logs, test results, or other CI/CD outputs by default. It only has access to the repository files. If you need Claude to see test results, you can either: |
| 53 | + |
| 54 | +1. Instruct Claude to run tests before making commits |
| 55 | +2. Copy and paste CI results into a comment for Claude to analyze |
| 56 | + |
| 57 | +This limitation exists for security reasons but may be reconsidered in the future based on user feedback. |
| 58 | + |
| 59 | +### Why does Claude only update one comment instead of creating new ones? |
| 60 | + |
| 61 | +Claude is configured to update a single comment to avoid cluttering PR/issue discussions. All of Claude's responses, including progress updates and final results, will appear in the same comment with checkboxes showing task progress. |
| 62 | + |
| 63 | +## Branch and Commit Behavior |
| 64 | + |
| 65 | +### Why did Claude create a new branch when commenting on a closed PR? |
| 66 | + |
| 67 | +Claude's branch behavior depends on the context: |
| 68 | + |
| 69 | +- **Open PRs**: Pushes directly to the existing PR branch |
| 70 | +- **Closed/Merged PRs**: Creates a new branch (cannot push to closed PR branches) |
| 71 | +- **Issues**: Always creates a new branch with a timestamp |
| 72 | + |
| 73 | +### Why are my commits shallow/missing history? |
| 74 | + |
| 75 | +For performance, Claude uses shallow clones: |
| 76 | + |
| 77 | +- PRs: `--depth=20` (last 20 commits) |
| 78 | +- New branches: `--depth=1` (single commit) |
| 79 | + |
| 80 | +If you need full history, you can configure this in your workflow before calling Claude in the `actions/checkout` step. |
| 81 | + |
| 82 | +``` |
| 83 | +- uses: actions/checkout@v4 |
| 84 | + depth: 0 # will fetch full repo history |
| 85 | +``` |
| 86 | +
|
| 87 | +## Configuration and Tools |
| 88 | +
|
| 89 | +### What's the difference between `direct_prompt` and `custom_instructions`? |
| 90 | +
|
| 91 | +These inputs serve different purposes in how Claude responds: |
| 92 | +
|
| 93 | +- **`direct_prompt`**: Bypasses trigger detection entirely. When provided, Claude executes this exact instruction regardless of comments or mentions. Perfect for automated workflows where you want Claude to perform a specific task on every run (e.g., "Update the API documentation based on changes in this PR"). |
| 94 | +
|
| 95 | +- **`custom_instructions`**: Additional context added to Claude's system prompt while still respecting normal triggers. These instructions modify Claude's behavior but don't replace the triggering comment. Use this to give Claude standing instructions like "You have been granted additional tools for ...". |
| 96 | +
|
| 97 | +Example: |
| 98 | +
|
| 99 | +```yaml |
| 100 | +# Using direct_prompt - runs automatically without @claude mention |
| 101 | +direct_prompt: "Review this PR for security vulnerabilities" |
| 102 | +
|
| 103 | +# Using custom_instructions - still requires @claude trigger |
| 104 | +custom_instructions: "Focus on performance implications and suggest optimizations" |
| 105 | +``` |
| 106 | + |
| 107 | +### Why doesn't Claude execute my bash commands? |
| 108 | + |
| 109 | +The Bash tool is **disabled by default** for security. To enable individual bash commands: |
| 110 | + |
| 111 | +```yaml |
| 112 | +allowed_tools: "Bash(npm:*),Bash(git:*)" # Allows only npm and git commands |
| 113 | +``` |
| 114 | +
|
| 115 | +### Can Claude work across multiple repositories? |
| 116 | +
|
| 117 | +No, Claude's GitHub app token is sandboxed to the current repository only. It cannot push to any other repositories. It can, however, read public repositories, but to get access to this, you must configure it with tools to do so. |
| 118 | +
|
| 119 | +## MCP Servers and Extended Functionality |
| 120 | +
|
| 121 | +### What MCP servers are available by default? |
| 122 | +
|
| 123 | +Claude Code Action automatically configures two MCP servers: |
| 124 | +
|
| 125 | +1. **GitHub MCP server**: For GitHub API operations |
| 126 | +2. **File operations server**: For advanced file manipulation |
| 127 | +
|
| 128 | +However, tools from these servers still need to be explicitly allowed via `allowed_tools`. |
| 129 | + |
| 130 | +## Troubleshooting |
| 131 | + |
| 132 | +### How can I debug what Claude is doing? |
| 133 | + |
| 134 | +Check the GitHub Action log for Claude's run for the full execution trace. |
| 135 | + |
| 136 | +### Why can't I trigger Claude with `@claude-mention` or `claude!`? |
| 137 | + |
| 138 | +The trigger uses word boundaries, so `@claude` must be a complete word. Variations like `@claude-bot`, `@claude!`, or `claude@mention` won't work unless you customize the `trigger_phrase`. |
| 139 | + |
| 140 | +## Best Practices |
| 141 | + |
| 142 | +1. **Always specify permissions explicitly** in your workflow file |
| 143 | +2. **Use GitHub Secrets** for API keys - never hardcode them |
| 144 | +3. **Be specific with `allowed_tools`** - only enable what's necessary |
| 145 | +4. **Test in a separate branch** before using on important PRs |
| 146 | +5. **Monitor Claude's token usage** to avoid hitting API limits |
| 147 | +6. **Review Claude's changes** carefully before merging |
| 148 | + |
| 149 | +## Getting Help |
| 150 | + |
| 151 | +If you encounter issues not covered here: |
| 152 | + |
| 153 | +1. Check the [GitHub Issues](https://github.com/anthropics/claude-code-action/issues) |
| 154 | +2. Review the [example workflows](https://github.com/anthropics/claude-code-action#examples) |
| 155 | + |
| 156 | +[perms]: https://docs.anthropic.com/en/docs/claude-code/settings#permissions |
0 commit comments