> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 自动修复失败的 CI 构建任务

export const UseCaseHero = ({title, description, prompt, category, features, devinUrl, agent, intent, playbookId, type}) => {
  const encodedPrompt = encodeURIComponent(prompt || '');
  const tag = 'docs-use-case-gallery';
  const utm = 'utm_source=docs&utm_medium=use-case-gallery&utm_campaign=hero-cta';
  const agentParams = (agent ? '&agent=' + agent : '') + (intent ? '&intent=' + intent : '') + (playbookId ? '&playbookId=' + playbookId : '');
  const devinHref = type === 'schedule' ? 'https://app.devin.ai/settings/schedules/create?' + utm + agentParams + (prompt ? '&prompt=' + encodedPrompt : '') : type === 'review' ? 'https://app.devin.ai/review?' + utm : agent === 'ada' ? 'https://app.devin.ai/search?' + utm + '&noSubmit=true' + (prompt ? '&prompt=' + encodedPrompt : '') : devinUrl ? devinUrl.includes('?') ? devinUrl + '&' + utm + agentParams : devinUrl + '?' + utm + agentParams : prompt ? 'https://app.devin.ai/?tags=' + tag + '&' + utm + agentParams + '&prompt=' + encodedPrompt : 'https://app.devin.ai/?' + utm + agentParams;
  const buttonLabel = type === 'schedule' ? 'Schedule in Devin ↗' : type === 'review' ? 'Set Up Devin Review ↗' : agent === 'advanced' ? 'Try in Devin ↗' : agent === 'dana' ? 'Try in Dana ↗' : agent === 'ada' ? 'Try in Ask Devin ↗' : 'Try in Devin ↗';
  const featureList = features ? features.split(',').map(f => f.trim()) : [];
  return <div className="uc-hero">
      <div className="uc-hero-inner">
        <div className="uc-hero-left">
          <h1 className="uc-hero-title">{title}</h1>
          <p className="uc-hero-desc">{description}</p>
          <div>
            <a href={devinHref} target="_blank" rel="noopener noreferrer" className="try-in-devin-btn">
              {buttonLabel}
            </a>
          </div>
        </div>
        <div className="uc-hero-meta">
          <div className="uc-meta-item">
            <span className="uc-meta-label">Author</span>
            <span className="uc-meta-value">Cognition</span>
          </div>
          <div className="uc-meta-item">
            <span className="uc-meta-label">Category</span>
            <span className="uc-meta-value">{category}</span>
          </div>
          {featureList.length > 0 && <div className="uc-meta-item">
              <span className="uc-meta-label">Features</span>
              <span className="uc-meta-value">{featureList.join(', ')}</span>
            </div>}
        </div>
      </div>
    </div>;
};

export const PromptBlock = ({children, type, agent, intent, playbookId}) => {
  var utm = 'utm_source=docs&utm_medium=use-case-gallery&utm_campaign=prompt-block';
  var tag = 'docs-use-case-gallery';
  var agentParams = (agent ? '&agent=' + agent : '') + (intent ? '&intent=' + intent : '') + (playbookId ? '&playbookId=' + playbookId : '');
  var label = type === 'schedule' ? 'Schedule in Devin' : type === 'playbook' ? 'Create Playbook' : type === 'knowledge' ? 'Add to Knowledge' : agent === 'advanced' ? 'Try in Devin' : agent === 'dana' ? 'Try in Dana' : agent === 'ada' ? 'Try in Ask Devin' : 'Try in Devin';
  var buildUrl = function (text) {
    var encoded = encodeURIComponent(text);
    if (type === 'schedule') return 'https://app.devin.ai/settings/schedules/create?' + utm + agentParams + '&prompt=' + encoded;
    if (type === 'playbook') return 'https://app.devin.ai/settings/playbooks/create?' + utm + '&body=' + encoded;
    if (type === 'knowledge') return 'https://app.devin.ai/knowledge?' + utm + '&body=' + encoded;
    if (agent === 'ada') return 'https://app.devin.ai/search?' + utm + '&noSubmit=true&prompt=' + encoded;
    return 'https://app.devin.ai/?tags=' + tag + '&' + utm + agentParams + '&prompt=' + encoded;
  };
  const ref = React.useRef(null);
  const [href, setHref] = React.useState('#');
  React.useEffect(() => {
    if (!ref.current) return;
    var codeEl = ref.current.querySelector('pre code');
    if (codeEl) {
      var text = codeEl.textContent.trim();
      if (text) setHref(buildUrl(text));
    }
    var header = ref.current.querySelector('[data-component-part="code-block-header"]');
    if (header && !header.querySelector('.prompt-block-devin-link')) {
      var link = document.createElement('a');
      link.href = href;
      link.target = '_blank';
      link.rel = 'noopener noreferrer';
      link.className = 'prompt-block-devin-link';
      link.style.cssText = 'display:inline-flex;align-items:center;gap:6px;text-decoration:none;color:#fff;font-size:11px;font-weight:500;padding:4px 10px;border-radius:6px;white-space:nowrap;background:#317CFF;transition:background 0.2s;margin-left:8px;';
      link.innerHTML = '<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/><polyline points="15 3 21 3 21 9"/><line x1="10" y1="14" x2="21" y2="3"/></svg> ' + label;
      link.onmouseenter = function () {
        link.style.background = '#2968D9';
      };
      link.onmouseleave = function () {
        link.style.background = '#317CFF';
      };
      header.appendChild(link);
    }
    var existingLink = ref.current.querySelector('.prompt-block-devin-link');
    if (existingLink && href !== '#') existingLink.href = href;
  });
  return <div className="prompt-block" ref={ref}>{children}</div>;
};

<UseCaseHero title="自动修复失败的 CI 构建" description="添加一个调用 Devin 的 GitHub Action，用于修复你 PR 中失败的 CI。" prompt="帮我设置一个 GitHub Action，自动触发 Devin 来修复失败的 CI 构建。请按照 https://docs.devin.ai/use-cases/gallery/api-github-actions-ci-fix 上的指南，逐步带我完成：存储 API key、添加 workflow 文件，以及配置作用范围，使其只处理合适的失败。" category="自动化" features="API" />

<div className="uc-detail-wrapper">
  <Tip>不想手动配置？将本页链接粘贴到 Devin session 中，让它为你完成所有设置。</Tip>

  <Steps>
    <Step title="Store your Devin API key in GitHub">
      The workflow calls Devin's [v3 API](/zh/api-reference/v3/overview) to create sessions programmatically. Create a service user and store its token as a GitHub Actions secret:

      1. Go to [app.devin.ai](https://app.devin.ai/?utm_source=docs\&utm_medium=use-case-gallery) > **Settings** > **Service Users** and create a service user with `ManageOrgSessions` permission
      2. Copy the API token shown after creation — it's only displayed once
      3. In your GitHub repo, navigate to **Settings > Secrets and variables > Actions**
      4. Add two secrets: `DEVIN_API_KEY` (the token) and `DEVIN_ORG_ID` (your organization ID — get it by calling `GET https://api.devin.ai/v3/enterprise/organizations` with your token)

      请确保该代码仓库已在 [Devin 的 Machine 上完成配置](/zh/onboard-devin/environment)，以便 Devin 可以克隆、构建并向其推送代码。
    </Step>

    <Step title="Add the workflow file">
      Create `.github/workflows/devin-ci-fix.yml`. This workflow fires whenever your existing CI workflow completes with a failure, extracts the failing job names, and calls the [Devin API](/zh/api-reference/v3/sessions/post-organizations-sessions) to start a fix session:

      ```yaml theme={null}
      name: Auto-fix CI with Devin

      on:
        workflow_run:
          workflows: ["CI"]
          types: [completed]

      jobs:
        trigger-devin-fix:
          if: >
            github.event.workflow_run.conclusion == 'failure' &&
            github.event.workflow_run.pull_requests[0]
          runs-on: ubuntu-latest
          steps:
            - name: Get failure details
              id: failure
              uses: actions/github-script@v7
              with:
                script: |
                  const run = context.payload.workflow_run;
                  const pr = run.pull_requests[0];
                  const jobs = await github.rest.actions.listJobsForWorkflowRun({
                    owner: context.repo.owner,
                    repo: context.repo.repo,
                    run_id: run.id
                  });
                  const failed = jobs.data.jobs
                    .filter(j => j.conclusion === 'failure')
                    .map(j => j.name);
                  core.setOutput('pr_number', pr.number);
                  core.setOutput('branch', pr.head.ref);
                  core.setOutput('failed_jobs', failed.join(', '));
                  core.setOutput('run_url', run.html_url);

            - name: Trigger Devin session
              run: |
                curl -s -X POST "https://api.devin.ai/v3/organizations/${{ secrets.DEVIN_ORG_ID }}/sessions" \
                  -H "Authorization: Bearer ${{ secrets.DEVIN_API_KEY }}" \
                  -H "Content-Type: application/json" \
                  -d "{
                    \"prompt\": \"CI failed on PR #${{ steps.failure.outputs.pr_number }} in ${{ github.repository }}. Failed jobs: ${{ steps.failure.outputs.failed_jobs }}. Run: ${{ steps.failure.outputs.run_url }}. Branch: ${{ steps.failure.outputs.branch }}. Read the CI logs, identify the root cause, and push a fix to the branch.\"
                  }"
      ```

      Replace `"CI"` in the `workflows` array with the exact `name:` from your existing CI workflow file (e.g., `"Tests"`, `"Build & Test"`).

      Use the `tags` field in the request body (e.g., `"tags": ["ci-fix", "pr-312"]`) to track which CI failures have already triggered sessions and avoid duplicates.
    </Step>

    <Step title="What happens when CI fails">
      当一个 PR 的 CI 运行失败时，Action 会提取失败详情，并将其作为 session 提示传递给 Devin。以下是一个典型的自动修复流程：

      1. **读取 CI logs** — Devin 打开运行 URL，并解析失败 job 中的错误输出、堆栈跟踪和测试结果
      2. **将错误追踪到代码** — 在 PR 分支上定位相关文件和行 (例如 `UserList.tsx:34`) ，并读取周边代码及最近的 diff
      3. **推送修复** — 直接向 PR 分支提交有针对性的更改，这会自动重新触发 CI
      4. **在 PR 上评论** — 发布摘要，说明 root cause 以及做了哪些更改

      来自 Devin 的 PR 评论示例：

      ```
      CI failure in test-unit — fixed

      Root cause: `UserList.tsx:34` calls `.map()` on `props.users`, which is
      undefined when the API returns an empty response body instead of `[]`.

      Fix: Added a fallback — `const users = props.users ?? [];`
      Added a test case for the empty-response scenario.
      All 312 tests passing.
      ```

      <PromptBlock>
        ```txt 跟进一个不稳定的测试 theme={null}
        这次 CI 失败其实是由于一个不稳定的测试——重试时就能通过。排查
        src/__tests__/UserList.test.tsx 中的测试并修复其不稳定问题。检查
        是否是由于时序问题、竞态条件，或在多次运行之间缺少清理造成的。
        ```
      </PromptBlock>
    </Step>

    <Step title="只针对合适的失败项">
      并非所有 CI 失败都适合自动修复——基础设施超时和 Docker 构建问题并不能单纯通过修改代码解决。添加一个条件，使只有相关的作业失败才会触发 Devin：

      ```yaml theme={null}
            - name: Trigger Devin session
              if: >
                contains(steps.failure.outputs.failed_jobs, 'test') ||
                contains(steps.failure.outputs.failed_jobs, 'lint') ||
                contains(steps.failure.outputs.failed_jobs, 'typecheck')
              run: |
                curl -s -X POST "https://api.devin.ai/v3/organizations/${{ secrets.DEVIN_ORG_ID }}/sessions" \
                ...
      ```

      ### 保持修复内容易于审查

      Devin 会推送一个修复提交，但在合并之前，这个 PR 仍然需要人工审查。将自动修复视为开发者的起点，而不是代码审查的替代。如果 Devin 无法解决该失败，它会在 PR 上发表评论，说明它发现了什么，方便工程师在此基础上接手处理。
    </Step>
  </Steps>
</div>