Skip to content

Add HolmesGPT GitHub Actions integration documentation#2051

Merged
arikalon1 merged 3 commits intomasterfrom
claude/add-github-action-docs-KZ6tM
May 9, 2026
Merged

Add HolmesGPT GitHub Actions integration documentation#2051
arikalon1 merged 3 commits intomasterfrom
claude/add-github-action-docs-KZ6tM

Conversation

@arikalon1
Copy link
Copy Markdown
Contributor

Summary

This PR adds comprehensive documentation for the new HolmesGPT GitHub Actions integration, enabling users to automatically review pull requests using HolmesGPT within their GitHub workflows.

Key Changes

  • New documentation structure: Created docs/configuration/github-actions/ directory with index and integration guides
  • HolmesGPT PR Review guide (holmes-pr-review.rst): Complete setup and usage documentation including:
    • Overview of how the integration works
    • Prerequisites (GitHub integration setup)
    • Step-by-step setup instructions (API key creation, account/cluster ID retrieval, GitHub secrets configuration)
    • Ready-to-use GitHub Actions workflow template with curl-based Holmes Chat API integration
    • Customization guidance for review prompts
    • Configuration reference and troubleshooting section
  • GitHub Actions index (index.rst): Landing page for GitHub Actions integrations with links to available actions
  • Documentation navigation: Updated main docs/index.rst to include new GitHub Actions section in the table of contents

Notable Implementation Details

  • The workflow uses curl to call the Holmes Chat API with PR context and custom review prompts
  • Includes error handling with retry logic and JSON response parsing
  • Provides clear troubleshooting guidance for common setup issues (missing credentials, invalid cluster ID, disabled GitHub integration)
  • Emphasizes that the integration requires the GitHub toolset to be enabled in HolmesGPT
  • Includes visual aids (API key generation screenshot) for better user experience

https://claude.ai/code/session_01KKnLu24WBHBc4SjbpxPrMM

Adds a new "GitHub Actions" section to the docs sidebar, next to "HTTP APIs",
documenting the HolmesGPT PR review action: prerequisites, Robusta API key and
cluster setup, required GitHub secrets, the workflow file, and troubleshooting.

https://claude.ai/code/session_01KKnLu24WBHBc4SjbpxPrMM
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

Docker image ready for 1457c4e (built in 2m 38s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:1457c4e
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:1457c4e me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:1457c4e
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:1457c4e

Patch Helm values in one line:

helm upgrade --install robusta robusta/robusta \
  --reuse-values \
  --set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:1457c4e

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6a9725d9-9b6d-41e3-b3a5-494c64c3ca75

📥 Commits

Reviewing files that changed from the base of the PR and between 2c4de9a and 1a4407e.

📒 Files selected for processing (1)
  • docs/index.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/index.rst

Walkthrough

Adds documentation for a GitHub Actions integration that runs HolmesGPT PR Review: availability notes, required Robusta API key and secrets, example workflow (.github/workflows/holmes-pr-review.yaml), prompt customization, end-to-end flow, and troubleshooting. Documentation-only; no code changes.

Changes

GitHub Actions docs

Layer / File(s) Summary
Index / Navigation
docs/index.rst
Inserts a hidden "GitHub Actions" toctree (maxdepth 4) linking the overview and HolmesGPT PR Review pages.
Overview page
docs/configuration/github-actions/index.rst
Adds a GitHub Actions overview describing HolmesGPT integration and availability (Robusta SaaS and self-hosted commercial only).
Feature doc / Usage
docs/configuration/github-actions/holmes-pr-review.rst
New detailed guide: required Robusta API key scope ("Robusta AI Write"), capture ACCOUNT_ID/CLUSTER_ID, repository secrets (ROBUSTA_API_KEY, ROBUSTA_ACCOUNT_ID, ROBUSTA_CLUSTER_ID), example workflow (.github/workflows/holmes-pr-review.yaml) with environment variables, jq/curl request to $RELAY_BASE_URL/api/holmes/$ACCOUNT_ID/chat, prompt customization, and troubleshooting notes for missing comments, 401, and 404/cluster mismatches.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • aantn
  • pavangudiwada
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately and concisely summarizes the main change: adding documentation for HolmesGPT GitHub Actions integration.
Description check ✅ Passed The pull request description is comprehensive and directly related to the changeset, detailing all documentation additions including structure, setup guides, and configuration references.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/add-github-action-docs-KZ6tM

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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)
docs/configuration/github-actions/holmes-pr-review.rst (1)

93-97: Add explicit HTTP timeouts to improve workflow reliability.

The curl example has retries but no timeout bounds. Add connect/overall time limits so failed calls fail fast and don’t stall CI jobs.

Suggested hardening for the example command
-              curl -fsS --retry 2 \
+              curl -fsS --retry 2 --connect-timeout 10 --max-time 90 \
                 -H "Authorization: Bearer $API_KEY" \
                 -H "Content-Type: application/json" \
                 --data-binary `@body.json` \
                 "$RELAY_BASE_URL/api/holmes/$ACCOUNT_ID/chat" > response.json
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/configuration/github-actions/holmes-pr-review.rst` around lines 93 - 97,
The curl example currently retries but lacks timeout bounds; update the curl
invocation (the long command that posts body.json to
"$RELAY_BASE_URL/api/holmes/$ACCOUNT_ID/chat") to include explicit connect and
overall timeouts (e.g., add --connect-timeout 10 and --max-time 30) so requests
fail fast in CI, and keep the existing -fsS/--retry flags intact; ensure the
timeout options are placed alongside the existing headers and --data-binary
options.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/configuration/github-actions/holmes-pr-review.rst`:
- Around line 4-6: Update the GitHub Actions workflow example to remove
ambiguity about the relay endpoint by either (A) documenting the self-hosted
relay URL and showing how to set it via an env var (use RELAY_BASE_URL in the
workflow example and explain the self-hosted value), or (B) explicitly state in
the note that self-hosted commercial deployments use the SaaS relay
(https://api.robusta.dev) so no change is needed; ensure the docs around the
workflow example reference RELAY_BASE_URL and include a short example of setting
it as an environment variable for self-hosted installs.

---

Nitpick comments:
In `@docs/configuration/github-actions/holmes-pr-review.rst`:
- Around line 93-97: The curl example currently retries but lacks timeout
bounds; update the curl invocation (the long command that posts body.json to
"$RELAY_BASE_URL/api/holmes/$ACCOUNT_ID/chat") to include explicit connect and
overall timeouts (e.g., add --connect-timeout 10 and --max-time 30) so requests
fail fast in CI, and keep the existing -fsS/--retry flags intact; ensure the
timeout options are placed alongside the existing headers and --data-binary
options.
🪄 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: 90383609-9f3b-4e5c-8ecf-96e505f690da

📥 Commits

Reviewing files that changed from the base of the PR and between c22a51e and cf9c8c9.

📒 Files selected for processing (3)
  • docs/configuration/github-actions/holmes-pr-review.rst
  • docs/configuration/github-actions/index.rst
  • docs/index.rst

Comment thread docs/configuration/github-actions/holmes-pr-review.rst
yuryrudey
yuryrudey previously approved these changes May 9, 2026
@arikalon1 arikalon1 merged commit 633fc81 into master May 9, 2026
7 checks passed
@arikalon1 arikalon1 deleted the claude/add-github-action-docs-KZ6tM branch May 9, 2026 08:45
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.

3 participants