8.3 CI/CD 集成

约 2422 字大约 8 分钟

持续集成（CI）和持续部署（CD）是现代软件开发流程的核心组成部分。将 Claude Code 集成到 CI/CD 流程中，可以自动化代码审查、测试、文档生成等任务，显著提高开发效率和代码质量。

CI/CD 集成概述

为什么集成 Claude Code 到 CI/CD

将 Claude Code 集成到 CI/CD 流程中可以带来以下好处：

自动化代码审查：在每次提交时自动进行代码审查
智能测试生成：自动生成测试用例和测试代码
文档自动生成：自动生成和更新项目文档
代码质量检查：自动检查代码质量、安全性和性能问题
减少人工干预：减少重复性的人工任务
提高开发效率：加快开发和部署流程

CI/CD 集成的挑战

在集成 Claude Code 到 CI/CD 时，需要考虑以下挑战：

认证配置：需要配置 Anthropic API 认证
环境变量管理：安全地管理敏感信息
错误处理：处理 Claude Code 执行失败的情况
性能优化：优化 CI/CD 流程的执行时间
成本控制：控制 API 调用成本
结果展示：将 Claude Code 的结果展示在 CI/CD 界面中

GitHub Actions 集成

1. 基本配置

示例：GitHub Actions 工作流

name: Claude Code CI

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  code-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install Claude Code
        run: npm install -g @anthropic-ai/claude-code

      - name: Configure Claude Code
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: |
          claude login --api-key $ANTHROPIC_API_KEY

      - name: Run code review
        run: |
          claude -p "审查最近的代码变更" \
            --output-format json \
            > review.json

      - name: Upload review results
        uses: actions/upload-artifact@v3
        with:
          name: code-review
          path: review.json

2. 代码审查工作流

示例：自动代码审查

name: Automated Code Review

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  code-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Install Claude Code
        run: npm install -g @anthropic-ai/claude-code

      - name: Configure Claude Code
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: |
          claude login --api-key $ANTHROPIC_API_KEY

      - name: Get changed files
        id: changed-files
        run: |
          git diff --name-only origin/main...HEAD > changed_files.txt
          echo "files=$(cat changed_files.txt)" >> $GITHUB_OUTPUT

      - name: Review changed files
        run: |
          claude -p "审查以下文件的代码质量、安全性和性能：" \
            --input-format text \
            --output-format json \
            < changed_files.txt \
            > review.json

      - name: Post review as comment
        uses: actions/github-script@v6
        with:
          script: |
            const fs = require('fs');
            const review = JSON.parse(fs.readFileSync('review.json', 'utf8'));
            
            let comment = '## 代码审查结果\n\n';
            comment += `**审查时间**: ${new Date().toISOString()}\n\n`;
            comment += '### 审查意见\n\n';
            comment += review.content || '无审查意见';
            
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: comment
            });

3. 测试生成和执行

示例：自动测试生成

name: Automated Testing

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]

jobs:
  generate-tests:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install Claude Code
        run: npm install -g @anthropic-ai/claude-code

      - name: Configure Claude Code
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: |
          claude login --api-key $ANTHROPIC_API_KEY

      - name: Generate unit tests
        run: |
          claude -p "为所有 Python 文件生成单元测试" \
            --output-format json \
            > unit_tests.json

      - name: Generate integration tests
        run: |
          claude -p "为 API 端点生成集成测试" \
            --output-format json \
            > integration_tests.json

      - name: Save generated tests
        uses: actions/upload-artifact@v3
        with:
          name: generated-tests
          path: |
            unit_tests.json
            integration_tests.json

  run-tests:
    needs: generate-tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Download generated tests
        uses: actions/download-artifact@v3
        with:
          name: generated-tests

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: Install dependencies
        run: |
          pip install pytest pytest-cov

      - name: Run unit tests
        run: |
          claude -p "运行单元测试" \
            --input-format json \
            < unit_tests.json

      - name: Run integration tests
        run: |
          claude -p "运行集成测试" \
            --input-format json \
            < integration_tests.json

      - name: Generate coverage report
        run: |
          claude -p "生成测试覆盖率报告" \
            --output-format json \
            > coverage.json

      - name: Upload coverage report
        uses: actions/upload-artifact@v3
        with:
          name: coverage-report
          path: coverage.json

4. 文档生成工作流

示例：自动文档生成

name: Documentation Generation

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  generate-docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install Claude Code
        run: npm install -g @anthropic-ai/claude-code

      - name: Configure Claude Code
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: |
          claude login --api-key $ANTHROPIC_API_KEY

      - name: Extract API documentation
        run: |
          claude -p "提取所有 API 端点的文档" \
            --output-format json \
            > api_docs.json

      - name: Generate Markdown documentation
        run: |
          claude -p "根据提取的信息生成 Markdown 文档" \
            --input-format json \
            --output-format markdown \
            > API.md

      - name: Generate HTML documentation
        run: |
          claude -p "根据提取的信息生成 HTML 文档" \
            --input-format json \
            --output-format html \
            > API.html

      - name: Commit documentation
        run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
          git add API.md API.html
          git diff --quiet && git diff --staged --quiet || git commit -m "Update documentation"
          git push

GitLab CI 集成

1. 基本配置

示例：GitLab CI 配置

# .gitlab-ci.yml

stages:
  - review
  - test
  - deploy

variables:
  ANTHROPIC_API_KEY: $ANTHROPIC_API_KEY

code-review:
  stage: review
  image: node:18
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude -p "审查最近的代码变更" --output-format json > review.json
  artifacts:
    paths:
      - review.json
    expire_in: 1 week

automated-testing:
  stage: test
  image: python:3.10
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
    - pip install pytest
  script:
    - claude -p "生成测试用例" --output-format json > tests.json
    - claude -p "运行测试" --input-format json < tests.json
  artifacts:
    paths:
      - tests.json
    expire_in: 1 week

deploy:
  stage: deploy
  image: node:18
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude -p "部署应用到生产环境"
  only:
    - main

2. 高级工作流

示例：多阶段工作流

# .gitlab-ci.yml

stages:
  - analyze
  - review
  - test
  - document
  - deploy

variables:
  ANTHROPIC_API_KEY: $ANTHROPIC_API_KEY
  PROJECT_DIR: ./src

code-analysis:
  stage: analyze
  image: node:18
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude --add-dir $PROJECT_DIR -p "分析代码质量" --output-format json > analysis.json
  artifacts:
    paths:
      - analysis.json
    expire_in: 1 week

code-review:
  stage: review
  image: node:18
  dependencies:
    - code-analysis
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude -p "根据分析结果进行代码审查" --input-format json < analysis.json > review.json
  artifacts:
    paths:
      - review.json
    expire_in: 1 week

automated-testing:
  stage: test
  image: python:3.10
  dependencies:
    - code-review
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
    - pip install pytest pytest-cov
  script:
    - claude -p "生成测试用例" --output-format json > tests.json
    - claude -p "运行测试" --input-format json < tests.json
    - claude -p "生成覆盖率报告" --output-format json > coverage.json
  artifacts:
    paths:
      - tests.json
      - coverage.json
    expire_in: 1 week

documentation:
  stage: document
  image: node:18
  dependencies:
    - automated-testing
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude -p "生成项目文档" --output-format markdown > README.md
    - claude -p "生成 API 文档" --output-format html > API.html
  artifacts:
    paths:
      - README.md
      - API.html
    expire_in: 1 week

deploy:
  stage: deploy
  image: node:18
  dependencies:
    - documentation
  before_script:
    - npm install -g @anthropic-ai/claude-code
    - claude login --api-key $ANTHROPIC_API_KEY
  script:
    - claude -p "部署应用到生产环境"
  only:
    - main

Jenkins 集成

1. 基本配置

示例：Jenkins Pipeline

pipeline {
    agent any
    
    environment {
        ANTHROPIC_API_KEY = credentials('anthropic-api-key')
    }
    
    stages {
        stage('Checkout') {
            steps {
                checkout scm
            }
        }
        
        stage('Install Claude Code') {
            steps {
                sh 'npm install -g @anthropic-ai/claude-code'
            }
        }
        
        stage('Configure') {
            steps {
                sh 'claude login --api-key $ANTHROPIC_API_KEY'
            }
        }
        
        stage('Code Review') {
            steps {
                sh '''
                    claude -p "审查最近的代码变更" \
                        --output-format json \
                        > review.json
                '''
            }
        }
        
        stage('Run Tests') {
            steps {
                sh '''
                    claude -p "生成测试用例" \
                        --output-format json \
                        > tests.json
                    
                    claude -p "运行测试" \
                        --input-format json \
                        < tests.json
                '''
            }
        }
        
        stage('Generate Documentation') {
            steps {
                sh '''
                    claude -p "生成项目文档" \
                        --output-format markdown \
                        > README.md
                '''
            }
        }
    }
    
    post {
        always {
            archiveArtifacts artifacts: '*.json,*.md', fingerprint: true
        }
    }
}

2. 高级配置

示例：多分支 Pipeline

pipeline {
    agent any
    
    environment {
        ANTHROPIC_API_KEY = credentials('anthropic-api-key')
    }
    
    stages {
        stage('Checkout') {
            steps {
                checkout scm
            }
        }
        
        stage('Install Claude Code') {
            steps {
                sh 'npm install -g @anthropic-ai/claude-code'
            }
        }
        
        stage('Configure') {
            steps {
                sh 'claude login --api-key $ANTHROPIC_API_KEY'
            }
        }
        
        stage('Analyze') {
            steps {
                sh '''
                    claude --add-dir ./src \
                        -p "分析代码质量" \
                        --output-format json \
                        > analysis.json
                '''
            }
        }
        
        stage('Review') {
            when {
                anyOf {
                    branch 'main'
                    branch 'develop'
                }
            }
            steps {
                sh '''
                    claude -p "进行代码审查" \
                        --input-format json \
                        < analysis.json \
                        > review.json
                '''
            }
        }
        
        stage('Test') {
            steps {
                sh '''
                    claude -p "生成并运行测试" \
                        --output-format json \
                        > test_results.json
                '''
            }
        }
        
        stage('Document') {
            steps {
                sh '''
                    claude -p "生成文档" \
                        --output-format markdown \
                        > docs.md
                '''
            }
        }
        
        stage('Deploy') {
            when {
                branch 'main'
            }
            steps {
                sh 'claude -p "部署应用"'
            }
        }
    }
    
    post {
        always {
            archiveArtifacts artifacts: '*.json,*.md', fingerprint: true
        }
        success {
            echo 'Pipeline 执行成功'
        }
        failure {
            echo 'Pipeline 执行失败'
        }
    }
}

最佳实践

1. 安全性

使用 Secrets：使用 CI/CD 平台的 Secrets 功能存储 API 密钥
环境变量：使用环境变量传递敏感信息
权限控制：限制 Claude Code 的权限范围
审计日志：记录所有 Claude Code 的调用

示例：安全配置

# GitHub Actions
env:
  ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

# GitLab CI
variables:
  ANTHROPIC_API_KEY: $ANTHROPIC_API_KEY

# Jenkins
environment {
    ANTHROPIC_API_KEY = credentials('anthropic-api-key')
}

2. 性能优化

并行执行：并行执行独立的任务
缓存依赖：缓存依赖项以减少安装时间
增量处理：只处理变更的文件
结果缓存：缓存 Claude Code 的结果

示例：性能优化

# GitHub Actions - 并行执行
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - name: Code review
        run: claude -p "审查代码"
  
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Run tests
        run: claude -p "运行测试"

3. 错误处理

失败重试：配置失败重试机制
错误通知：配置错误通知
回滚机制：配置回滚机制
日志记录：记录详细的日志

示例：错误处理

# GitHub Actions - 失败重试
- name: Run Claude Code
  uses: nick-invision/retry@v2
  with:
    timeout_minutes: 10
    max_attempts: 3
    command: claude -p "执行任务"

4. 成本控制

限制调用次数：限制 Claude Code 的调用次数
使用缓存：使用缓存减少重复调用
优化提示：优化提示词以减少 token 使用
监控成本：监控 API 调用成本

示例：成本控制

# 使用缓存
- name: Check cache
  id: cache
  uses: actions/cache@v3
  with:
    path: ~/.claude
    key: ${{ runner.os }}-claude-${{ hashFiles('**/package.json') }}

- name: Run Claude Code
  if: steps.cache.outputs.cache-hit != 'true'
  run: claude -p "执行任务"

常见问题

Q: 如何处理认证失败？

A: 检查 API 密钥是否正确配置，确保使用 CI/CD 平台的 Secrets 功能存储密钥。

Q: 如何优化 CI/CD 流程的执行时间？

A: 使用并行执行、缓存依赖、增量处理等技术优化执行时间。

Q: 如何处理 Claude Code 执行失败？

A: 配置失败重试机制、错误通知和回滚机制。

Q: 如何控制 API 调用成本？

A: 限制调用次数、使用缓存、优化提示词、监控成本。

总结

将 Claude Code 集成到 CI/CD 流程中可以显著提高开发效率和代码质量。通过掌握 GitHub Actions、GitLab CI 和 Jenkins 的集成方法，以及最佳实践（安全性、性能优化、错误处理、成本控制），您可以构建强大、可靠的 CI/CD 流程。

记住以下要点：

从简单开始：先实现基本的集成，逐步增加复杂性
注重安全：使用 Secrets 和环境变量保护敏感信息
优化性能：使用并行执行和缓存提高效率
控制成本：监控和控制 API 调用成本
持续改进：不断优化和改进 CI/CD 流程

在接下来的章节中，我们将学习批处理操作和实际工作流示例。