中文说明

deepseek-review also offers seamless integration with DeepSeek models on SiliconCloud. Sign Up Now to Claim Your Free 20 Million Tokens and start exploring its capabilities!

• Automate PR Reviews with DeepSeek via GitHub Action
• Review Remote GitHub PRs Directly from Your Local CLI
• Analyze Commit Changes with DeepSeek for Any Local Repository with CLI
• Fully Customizable: Choose Models, Base URLs, and Prompts
• Supports Self-Hosted DeepSeek Models for Enhanced Flexibility
• Perform Code Reviews for Changes That either Include or Exclude Specific Files
• Add skip cr or skip review to PR title or body to disable code review in GitHub Actions
• Cross-platform Support: Compatible with GitHub Runners across macOS, Ubuntu, and Windows.

• Trigger Code Review on Mention: Automatically initiate code review when the github-actions bot is mentioned in a PR comment.

Add a GitHub workflow with the following contents:

name: Code Review
on:
  pull_request_target:
    types:
      - opened      # Triggers when a PR is opened
      - reopened    # Triggers when a PR is reopened
      - synchronize # Triggers when a commit is pushed to the PR

# fix: GraphQL: Resource not accessible by integration (addComment) error
permissions:
  pull-requests: write

jobs:
  setup-deepseek-review:
    runs-on: ubuntu-latest
    name: Code Review
    steps:
      - name: DeepSeek Code Review
        uses: hustcer/deepseek-review@v1
        with:
          chat-token: ${{ secrets.CHAT_TOKEN }}

When a PR is created, DeepSeek code review will be automatically triggered, and the review results(depend on your prompt) will be posted as comments on the corresponding PR. For example:

• Example 1 with default prompts & Run Log.
• Example 2 with this prompt

If you don't want automatic review on PR creation, you can choose to trigger code review by adding a label. For example, create the following workflow:

name: Code Review
on:
  pull_request_target:
    types:
      - labeled     # Triggers when a label is added to the PR

# fix: GraphQL: Resource not accessible by integration (addComment) error
permissions:
  pull-requests: write

jobs:
  setup-deepseek-review:
    runs-on: ubuntu-latest
    name: Code Review
    # Make sure the code review happens only when the PR has the label 'ai review'
    if: contains(github.event.pull_request.labels.*.name, 'ai review')
    steps:
      - name: DeepSeek Code Review
        uses: hustcer/deepseek-review@v1
        with:
          chat-token: ${{ secrets.CHAT_TOKEN }}

With this setup, DeepSeek code review will not run automatically upon PR creation. Instead, it will only be triggered when you manually add the ai review label.

DeepSeek API Call Payload:

{
  // `$model` default value: deepseek-chat
  model: $model,
  stream: false,
  messages: [
    // `$sys_prompt` default value: You are a professional code review assistant responsible for
    // analyzing code changes in GitHub Pull Requests. Identify potential issues such as code
    // style violations, logical errors, security vulnerabilities, and provide improvement
    // suggestions. Clearly list the problems and recommendations in a concise manner.
    { role: 'system', content: $sys_prompt },
    // `$user_prompt` default value: Please review the following code changes
    // `diff_content` will be the code changes of current PR
    { role: 'user', content: $"($user_prompt):\n($diff_content)" }
  ]
}

To perform code reviews locally(should works for macOS, Ubuntu, and Windows), you need to install the following tools:

• Nushell. It is recommended to install the latest versions.
• Once Nushell was installed, simply clone this repository to your local machine, navigate to the repository directory, and run nu cr -h. You should see an output similar to the following:

Use DeepSeek AI to review code changes locally or in GitHub Actions

Usage:
  > cr {flags} (token)

Flags:
  -d, --debug: Debug mode
  -r, --repo <string>: GitHub repository name, e.g. hustcer/deepseek-review
  -n, --pr-number <string>: GitHub PR number
  -k, --gh-token <string>: Your GitHub token, fallback to GITHUB_TOKEN env var
  -t, --diff-to <string>: Diff to git REF
  -f, --diff-from <string>: Diff from git REF
  -l, --max-length <int>: Maximum length of the content for review, 0 means no limit.
  -m, --model <string>: Model name, deepseek-chat by default (default: 'deepseek-chat')
  -b, --base-url <string> (default: 'https://api.deepseek.com')
  -s, --sys-prompt <string>: Default to $DEFAULT_OPTIONS.SYS_PROMPT,
  -u, --user-prompt <string>: Default to $DEFAULT_OPTIONS.USER_PROMPT,
  -i, --include <string>: Comma separated file patterns to include in the code review
  -x, --exclude <string>: Comma separated file patterns to exclude in the code review
  -h, --help: Display the help message for this command

Parameters:
  token <string>: Your DeepSeek API token, fallback to CHAT_TOKEN env var (optional)

To perform code reviews locally, you need to modify the configuration file. A sample configuration file .env.example is already provided in the repository. Copy it to .env and adjust it according to your actual setup.

# Perform code review on the `git diff` changes in the local DEFAULT_LOCAL_REPO repo
nu cr
# Perform code review on the `git diff f536acc` changes in the local DEFAULT_LOCAL_REPO repo
nu cr --diff-from f536acc
# Perform code review on the `git diff f536acc 0dd0eb5` changes in the local DEFAULT_LOCAL_REPO repo
nu cr --diff-from f536acc --diff-to 0dd0eb5
# Perform code review on PR #31 in the remote DEFAULT_GITHUB_REPO repo
nu cr --pr-number 31
# Perform code review on PR #31 in the remote hustcer/deepseek-review repo
nu cr --pr-number 31 --repo hustcer/deepseek-review

Licensed under:

• MIT license (LICENSE or http://opensource.org/licenses/MIT)