docs: add comprehensive FAQ covering common gotchas and limitations

- Add FAQ.md with sections on triggering, authentication, capabilities, and troubleshooting
- Document key limitations including workflow access, PR creation, and CI results visibility
- Include workarounds for common issues like automated workflows and test result access
- Cover security considerations and best practices for safe usage

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Workflow yml file**
+If it's not sensitive, consider including a paste of your full Claude workflow.yml file.
+
+**API Provider**
+
+[ ] Anthropic First-Party API (default)
+[ ] AWS Bedrock
+[ ] GCP Vertex
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/issue-triage.yml

@@ -0,0 +1,104 @@
+name: Claude Issue Triage
+description: Run Claude Code for issue triage in GitHub Actions
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  triage-issue:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+      issues: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup GitHub MCP Server
+        run: |
+          mkdir -p /tmp/mcp-config
+          cat > /tmp/mcp-config/mcp-servers.json << 'EOF'
+          {
+            "github": {
+              "command": "docker",
+              "args": [
+                "run",
+                "-i",
+                "--rm",
+                "-e",
+                "GITHUB_PERSONAL_ACCESS_TOKEN",
+                "ghcr.io/github/github-mcp-server:sha-7aced2b"
+              ],
+              "env": {
+                "GITHUB_PERSONAL_ACCESS_TOKEN": "${{ secrets.GITHUB_TOKEN }}"
+              }
+            }
+          }
+          EOF
+
+      - name: Create triage prompt
+        run: |
+          mkdir -p /tmp/claude-prompts
+          cat > /tmp/claude-prompts/triage-prompt.txt << 'EOF'
+          You're an issue triage assistant for GitHub issues. Your task is to analyze the issue and select appropriate labels from the provided list.
+
+          IMPORTANT: Don't post any comments or messages to the issue. Your only action should be to apply labels.
+
+          Issue Information:
+          - REPO: ${{ github.repository }}
+          - ISSUE_NUMBER: ${{ github.event.issue.number }}
+
+          TASK OVERVIEW:
+
+          1. First, fetch the list of labels available in this repository by running: `gh label list`. Run exactly this command with nothing else.
+
+          2. Next, use the GitHub tools to get context about the issue:
+             - You have access to these tools:
+               - mcp__github__get_issue: Use this to retrieve the current issue's details including title, description, and existing labels
+               - mcp__github__get_issue_comments: Use this to read any discussion or additional context provided in the comments
+               - mcp__github__update_issue: Use this to apply labels to the issue (do not use this for commenting)
+               - mcp__github__search_issues: Use this to find similar issues that might provide context for proper categorization and to identify potential duplicate issues
+               - mcp__github__list_issues: Use this to understand patterns in how other issues are labeled
+             - Start by using mcp__github__get_issue to get the issue details
+
+          3. Analyze the issue content, considering:
+             - The issue title and description
+             - The type of issue (bug report, feature request, question, etc.)
+             - Technical areas mentioned
+             - Severity or priority indicators
+             - User impact
+             - Components affected
+
+          4. Select appropriate labels from the available labels list provided above:
+             - Choose labels that accurately reflect the issue's nature
+             - Be specific but comprehensive
+             - Select priority labels if you can determine urgency (high-priority, med-priority, or low-priority)
+             - Consider platform labels (android, ios) if applicable
+             - If you find similar issues using mcp__github__search_issues, consider using a "duplicate" label if appropriate. Only do so if the issue is a duplicate of another OPEN issue.
+
+          5. Apply the selected labels:
+             - Use mcp__github__update_issue to apply your selected labels
+             - DO NOT post any comments explaining your decision
+             - DO NOT communicate directly with users
+             - If no labels are clearly applicable, do not apply any labels
+
+          IMPORTANT GUIDELINES:
+          - Be thorough in your analysis
+          - Only select labels from the provided list above
+          - DO NOT post any comments to the issue
+          - Your ONLY action should be to apply labels using mcp__github__update_issue
+          - It's okay to not add any labels if none are clearly applicable
+          EOF
+
+      - name: Run Claude Code for Issue Triage
+        uses: anthropics/claude-code-base-action@beta
+        with:
+          prompt_file: /tmp/claude-prompts/triage-prompt.txt
+          allowed_tools: "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
+          mcp_config_file: /tmp/mcp-config/mcp-servers.json
+          timeout_minutes: "5"
+          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 node_modules
 
 **/.claude/settings.local.json

FAQ.md

@@ -0,0 +1,156 @@
+# Frequently Asked Questions (FAQ)
+
+This FAQ addresses common questions and gotchas when using the Claude Code GitHub Action.
+
+## Triggering and Authentication
+
+### Why doesn't tagging @claude from my automated workflow work?
+
+The `github-actions` user (and other GitHub Apps/bots) 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. When posting a comment on an issue or PR from your workflow, use your PAT instead of the `GITHUB_TOKEN` generated in your workflow.
+
+### Why does Claude say I don't have permission to trigger it?
+
+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.
+
+### Why am I getting OIDC authentication errors?
+
+If you're using the default GitHub App authentication, you must add the `id-token: write` permission to your workflow:
+
+```yaml
+permissions:
+  contents: read
+  id-token: write # Required for OIDC authentication
+```
+
+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.
+
+## Claude's Capabilities and Limitations
+
+### Why won't Claude update workflow files when I ask it to?
+
+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.
+
+### Why won't Claude rebase my branch?
+
+By default, Claude only uses commit tools for non-destructive changes to the branch. Claude is configured to:
+
+- Never push to branches other than where it was invoked (either its own branch or the PR branch)
+- Never force push or perform destructive operations
+
+You can grant additional tools via the `allowed_tools` input if needed:
+
+```yaml
+allowed_tools: "Bash(git rebase:*)" # Use with caution
+```
+
+### Why won't Claude create a pull request?
+
+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.
+
+### Why can't Claude run my tests or see CI results?
+
+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:
+
+1. Instruct Claude to run tests before making commits
+2. Copy and paste CI results into a comment for Claude to analyze
+
+This limitation exists for security reasons but may be reconsidered in the future based on user feedback.
+
+### Why does Claude only update one comment instead of creating new ones?
+
+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.
+
+## Branch and Commit Behavior
+
+### Why did Claude create a new branch when commenting on a closed PR?
+
+Claude's branch behavior depends on the context:
+
+- **Open PRs**: Pushes directly to the existing PR branch
+- **Closed/Merged PRs**: Creates a new branch (cannot push to closed PR branches)
+- **Issues**: Always creates a new branch with a timestamp
+
+### Why are my commits shallow/missing history?
+
+For performance, Claude uses shallow clones:
+
+- PRs: `--depth=20` (last 20 commits)
+- New branches: `--depth=1` (single commit)
+
+If you need full history, you can configure this in your workflow before calling Claude in the `actions/checkout` step.
+
+```
+- uses: actions/checkout@v4
+  depth: 0 # will fetch full repo history
+```
+
+## Configuration and Tools
+
+### What's the difference between `direct_prompt` and `custom_instructions`?
+
+These inputs serve different purposes in how Claude responds:
+
+- **`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").
+
+- **`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 ...".
+
+Example:
+
+```yaml
+# Using direct_prompt - runs automatically without @claude mention
+direct_prompt: "Review this PR for security vulnerabilities"
+
+# Using custom_instructions - still requires @claude trigger
+custom_instructions: "Focus on performance implications and suggest optimizations"
+```
+
+### Why doesn't Claude execute my bash commands?
+
+The Bash tool is **disabled by default** for security. To enable individual bash commands:
+
+```yaml
+allowed_tools: "Bash(npm:*),Bash(git:*)" # Allows only npm and git commands
+```
+
+### Can Claude work across multiple repositories?
+
+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.
+
+## MCP Servers and Extended Functionality
+
+### What MCP servers are available by default?
+
+Claude Code Action automatically configures two MCP servers:
+
+1. **GitHub MCP server**: For GitHub API operations
+2. **File operations server**: For advanced file manipulation
+
+However, tools from these servers still need to be explicitly allowed via `allowed_tools`.
+
+## Troubleshooting
+
+### How can I debug what Claude is doing?
+
+Check the GitHub Action log for Claude's run for the full execution trace.
+
+### Why can't I trigger Claude with `@claude-mention` or `claude!`?
+
+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`.
+
+## Best Practices
+
+1. **Always specify permissions explicitly** in your workflow file
+2. **Use GitHub Secrets** for API keys - never hardcode them
+3. **Be specific with `allowed_tools`** - only enable what's necessary
+4. **Test in a separate branch** before using on important PRs
+5. **Monitor Claude's token usage** to avoid hitting API limits
+6. **Review Claude's changes** carefully before merging
+
+## Getting Help
+
+If you encounter issues not covered here:
+
+1. Check the [GitHub Issues](https://github.com/anthropics/claude-code-action/issues)
+2. Review the [example workflows](https://github.com/anthropics/claude-code-action#examples)
+
+[perms]: https://docs.anthropic.com/en/docs/claude-code/settings#permissions

README.md

@@ -33,6 +33,10 @@ This command will guide you through setting up the GitHub app and required secre
 2. Add `ANTHROPIC_API_KEY` to your repository secrets ([Learn how to use secrets in GitHub Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions))
 3. Copy the workflow file from [`examples/claude.yml`](./examples/claude.yml) into your repository's `.github/workflows/`
 
+## 📚 FAQ
+
+Having issues or questions? Check out our [Frequently Asked Questions](./FAQ.md) for solutions to common problems and detailed explanations of Claude's capabilities and limitations.
+
 ## Usage
 
 Add a workflow file to your repository (e.g., `.github/workflows/claude.yml`):
@@ -446,7 +450,7 @@ anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
 ```
 
 This applies to all sensitive values including API keys, access tokens, and credentials.
-We also reccomend that you always use short-lived tokens when possible
+We also recommend that you always use short-lived tokens when possible
 
 ## License
 

action.yml

@@ -67,7 +67,7 @@ runs:
   using: "composite"
   steps:
     - name: Install Bun
-      uses: oven-sh/setup-bun@v2
+      uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # https://github.com/oven-sh/setup-bun/releases/tag/v2.0.2
       with:
         bun-version: 1.2.11
 
@@ -94,7 +94,7 @@ runs:
     - name: Run Claude Code
       id: claude-code
       if: steps.prepare.outputs.contains_trigger == 'true'
-      uses: anthropics/claude-code-base-action@beta
+      uses: anthropics/claude-code-base-action@78eef48a8f466f7a800a2315134506d4c7ad9163 # v0.0.7
       with:
         prompt_file: /tmp/claude-prompts/claude-prompt.txt
         allowed_tools: ${{ env.ALLOWED_TOOLS }}

src/create-prompt/index.ts

@@ -594,6 +594,11 @@ What You CANNOT Do:
 - Execute commands outside the repository context
 - Run arbitrary Bash commands (unless explicitly allowed via allowed_tools configuration)
 - Perform branch operations (cannot merge branches, rebase, or perform other git operations beyond pushing commits)
+- Modify files in the .github/workflows directory (GitHub App permissions do not allow workflow modifications)
+- View CI/CD results or workflow run outputs (cannot access GitHub Actions logs or test results)
+
+When users ask you to perform actions you cannot do, politely explain the limitation and, when applicable, direct them to the FAQ for more information and workarounds:
+"I'm unable to [specific action] due to [reason]. You can find more information and potential workarounds in the [FAQ](https://github.com/anthropics/claude-code-action/blob/main/FAQ.md)."
 
 If a user asks for something outside these capabilities (and you have no other tools provided), politely explain that you cannot perform that action and suggest an alternative approach if possible.