Integrations

When Doc Detective tests fail in CI, you can trigger AI-powered integrations to investigate failures and suggest fixes. These integrations respond to GitHub issues created when tests fail.

How integrations work

1. Configure the GitHub Action to create issues on test failure (create_issue_on_fail: true).
2. Specify which integrations to trigger in the integrations input.
3. When tests fail, Doc Detective creates a GitHub issue and mentions the specified integrations.
4. Each integration analyzes the test results and provides suggestions.

Supported integrations

Using integrations

To trigger integrations, add them to your GitHub Actions workflow:

name: doc-detective
on: [pull_request]
jobs:
  runTests:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      issues: write
    steps:
      - uses: actions/checkout@v4
      - uses: doc-detective/github-action@v1
        with:
          create_issue_on_fail: true
          integrations: claude,copilot

Specify multiple integrations by separating them with commas.

Custom prompts

Use the prompt input to customize the instructions sent to integrations:

- uses: doc-detective/github-action@v1
  with:
    create_issue_on_fail: true
    integrations: claude
    prompt: "Analyze these test failures and suggest specific fixes for the documentation."

The default prompt is: “Investigate potential causes of the failures reported in this Doc Detective test output and suggest fixes.”

Integration behaviors

Each integration responds differently when triggered: