Bump to v1.3

* feat: Add skip cr or skip review feature

* feat: Add skip cr or skip review feature

* feat: Add skip cr or skip review feature

.github/workflows/cr.yml

@@ -6,7 +6,10 @@
 name: Code Review
 on:
   pull_request_target:
-    types: [opened, synchronize, reopened]
+    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:
@@ -20,4 +23,5 @@ jobs:
       - name: Deepseek Code Review
         uses: hustcer/deepseek-review@develop
         with:
+          max-length: 10000
           chat-token: ${{ secrets.CHAT_TOKEN }}

CHANGELOG.md

@@ -1,6 +1,22 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2025-01-31
+
+### Documentation
+
+- Update CLI help output (#53)
+- Polish documents (#57)
+
+### Features
+
+- Add `github-token` input (#55)
+- Add `skip cr` or `skip review` to PR title or body to disable code review in GitHub Actions (#56)
+
+### Miscellaneous Tasks
+
+- Increase `max-length` in review workflow (#54)
+
 ## [1.2.0] - 2025-01-31
 
 ### Breaking Changes

README.md

@@ -9,20 +9,26 @@
 - 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
+- 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`.
 
 ## Planned Features
 
-- [ ] **Skip Code Review via Commit Message**: Add `skip cr` or `skip review` to a commit message to disable code review for the associated PR.
 - [ ] **Trigger Code Review on Mention**: Automatically initiate code review when the `github-actions` bot is mentioned in a PR comment.
 - [ ] **Exclude Specific File Changes**: Ignore changes to specified files, such as `Cargo.lock`, `pnpm-lock.yaml`, and others.
 
 ## Code Review with GitHub Action
 
+Add a GitHub workflow with the following contents:
+
 ```yaml
 name: Code Review
 on:
   pull_request_target:
-    types: [opened]
+    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:
@@ -39,6 +45,8 @@ jobs:
           chat-token: ${{ secrets.CHAT_TOKEN }}
 ```
 
+When a PR is created, Deepseek code review will be automatically triggered, and the review results will be posted as comments on the corresponding PR. For example: [Example](https://github.com/hustcer/deepseek-review/pull/30) & [Run Log](https://github.com/hustcer/deepseek-review/actions/runs/13043609677/job/36390331791#step:2:53).
+
 ## Input Parameters
 
 | Name           | Type   | Description                                                             |
@@ -46,9 +54,10 @@ jobs:
 | chat-token     | String | Required, Deepseek API Token                                            |
 | model          | String | Optional, the model used for code review, defaults to `deepseek-chat`   |
 | base-url       | String | Optional, Deepseek API Base URL, defaults to `https://api.deepseek.com` |
-| max-length     | Int    | Optional, Maximum length of the content for review, if the content length exceeds this value, the review will be skipped. Default `0` means no limit. |
+| max-length     | Int    | Optional, Maximum length(Unicode width) of the content for review, if the content length exceeds this value, the review will be skipped. Default `0` means no limit. |
 | sys-prompt     | String | Optional, system prompt corresponding to `$sys_prompt` in the payload, default value see note below |
 | user-prompt    | String | Optional, user prompt corresponding to `$user_prompt` in the payload, default value see note below |
+| github-token   | String | Optional, The `GITHUB_TOKEN` secret or personal access token to authenticate. Defaults to `github.token`. |
 
 **Deepseek API Call Payload**:
 
@@ -74,14 +83,14 @@ jobs:
 
 ### Required Tools
 
-To perform code reviews locally, you need to install the following tools:
+To perform code reviews locally(should works for `macOS`, `Ubuntu`, and `Windows`), you need to install the following tools:
 
 - [`Nushell`](https://www.nushell.sh/book/installation.html) & [`Just`](https://just.systems/man/en/packages.html). It is recommended to install the latest versions.
 - If you need to review GitHub PRs locally, you also need to install [`gh`](https://cli.github.com/).
 - Once the tools are installed, simply clone this repository to your local machine, navigate to the repository directory, and run `just code-review -h` or `just cr -h`. You should see an output similar to the following:
 
 ```console
-Use Deepseek AI to review code changes
+Use Deepseek AI to review code changes locally or in GitHub Actions
 
 Usage:
   > deepseek-review {flags} (token)
@@ -90,9 +99,10 @@ Flags:
   -d, --debug: Debug mode
   -r, --repo <string>: GitHub repository name, e.g. hustcer/deepseek-review
   -n, --pr-number <string>: GitHub PR number
-  --gh-token <string>: Your GitHub token, GITHUB_TOKEN by default
+  --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')
   --base-url <string> (default: 'https://api.deepseek.com')
   -s, --sys-prompt <string> (default: '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.')
@@ -100,7 +110,7 @@ Flags:
   -h, --help: Display the help message for this command
 
 Parameters:
-  token <string>: Your Deepseek API token, fallback to CHAT_TOKEN (optional)
+  token <string>: Your Deepseek API token, fallback to CHAT_TOKEN env var (optional)
 
 ```
 

README.zh-CN.md

@@ -7,20 +7,26 @@
 - 通过本地 CLI 使用 Deepseek 分析任何本地仓库的提交变更
 - 完全可定制：选择模型、基础 URL 和提示词
 - 支持自托管 Deepseek 模型，提供更强的灵活性
+- 在 PR 的标题或描述中添加 `skip cr` or `skip review` 可跳过 GitHub Actions 里的代码审查
+- 跨平台：支持 GitHub `macOS`, `Ubuntu` & `Windows` Runners
 
 ## 计划支持特性
 
-- [ ] **通过提交信息跳过代码审查**：在提交信息中添加 `skip cr` 或 `skip review` 以跳过该 PR 的代码审查
 - [ ] **通过提及触发代码审查**：当 PR 评论中提及 `github-actions bot` 时，自动触发代码审查
 - [ ] **忽略指定文件变更**：忽略对指定文件的更改，例如 `Cargo.lock`、`pnpm-lock.yaml` 等
 
 ## 通过 GitHub Action 进行代码审核
 
+创建一个 GitHub workflow 内容如下：
+
 ```yaml
 name: Code Review
 on:
   pull_request_target:
-    types: [opened]
+    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:
@@ -37,6 +43,8 @@ jobs:
           chat-token: ${{ secrets.CHAT_TOKEN }}
 ```
 
+当 PR 创建的时候会自动触发 Deepseek 代码审核，并将审核结果以评论的方式发布到对应的 PR 上。比如：[示例](https://github.com/hustcer/deepseek-review/pull/30) & [运行日志](https://github.com/hustcer/deepseek-review/actions/runs/13043609677/job/36390331791#step:2:53)
+
 ## 输入参数
 
 | 名称           | 类型   | 描述                                                           |
@@ -44,9 +52,10 @@ jobs:
 | chat-token     | String | 必填，Deepseek API Token                                       |
 | model          | String | 可选，配置代码审核选用的模型，默认为 `deepseek-chat`           |
 | base-url       | String | 可选，Deepseek API Base URL, 默认为 `https://api.deepseek.com` |
-| max-length     | Int    | 可选，待审核内容的最大长度, 默认 `0` 表示没有限制，超过非零值则跳过审核 |
+| max-length     | Int    | 可选，待审核内容的最大 Unicode 长度, 默认 `0` 表示没有限制，超过非零值则跳过审核 |
 | sys-prompt     | String | 可选，系统 Prompt 对应入参中的 `$sys_prompt`, 默认值见后文注释      |
 | user-prompt    | String | 可选，用户 Prompt 对应入参中的 `$user_prompt`, 默认值见后文注释     |
+| github-token   | String | 可选，用于访问 API 进行 PR 管理的 GitHub Token，默认为 `${{ github.token }}` |
 
 Deepseek 接口调用入参:
 
@@ -72,14 +81,14 @@ Deepseek 接口调用入参:
 
 ### 依赖工具
 
-在本地进行代码审核需要安装以下工具：
+在本地进行代码审核，支持 `macOS`, `Ubuntu` & `Windows` 不过需要安装以下工具：
 
 - [`Nushell`](https://www.nushell.sh/book/installation.html) & [`Just`](https://just.systems/man/en/packages.html), 建议安装最新版本
 - 如果你需要在本地审核 GitHub PRs 还需要安装 [`gh`](https://cli.github.com/)
 - 接下来只需要把本仓库代码克隆到本地，然后进入仓库目录执行 `just code-review -h` 或者 `just cr -h` 即可看到类似如下输出:
 
 ```console
-Use Deepseek AI to review code changes
+Use Deepseek AI to review code changes locally or in GitHub Actions
 
 Usage:
   > deepseek-review {flags} (token)
@@ -88,9 +97,10 @@ Flags:
   -d, --debug: Debug mode
   -r, --repo <string>: GitHub repository name, e.g. hustcer/deepseek-review
   -n, --pr-number <string>: GitHub PR number
-  --gh-token <string>: Your GitHub token, GITHUB_TOKEN by default
+  --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')
   --base-url <string> (default: 'https://api.deepseek.com')
   -s, --sys-prompt <string> (default: '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.')
@@ -98,7 +108,7 @@ Flags:
   -h, --help: Display the help message for this command
 
 Parameters:
-  token <string>: Your Deepseek API token, fallback to CHAT_TOKEN (optional)
+  token <string>: Your Deepseek API token, fallback to CHAT_TOKEN env var (optional)
 
 ```
 

action.yaml

@@ -19,8 +19,8 @@ inputs:
     required: true
     description: 'Your deepseek API token.'
   max-length:
-    required: false
     default: 0
+    required: false
     description: 'The maximum length of the content for review, 0 means no limit.'
   model:
     required: false
@@ -38,6 +38,10 @@ inputs:
     required: false
     default: 'Please review the following code changes'
     description: 'The user prompt for deepseek API.'
+  github-token:
+    required: false
+    default: '${{ github.token }}'
+    description: 'The GITHUB_TOKEN secret or personal access token to authenticate. Defaults to `github.token`.'
 
 runs:
   using: 'composite'
@@ -52,15 +56,15 @@ runs:
       run: |
         const NU_LIB_DIRS = [ ${{ github.action_path }}/nu ]
         use review.nu *
-        let model = '${{inputs.model}}'
-        let ghToken = '${{ github.token }}'
-        let baseUrl = '${{inputs.base-url}}'
+        let model = '${{ inputs.model }}'
+        let baseUrl = '${{ inputs.base-url }}'
         let repo = '${{ github.repository }}'
-        let token = '${{inputs.chat-token}}'
-        let sysPrompt = '${{inputs.sys-prompt}}'
-        let userPrompt = '${{inputs.user-prompt}}'
-        let maxLength = ${{inputs.max-length}} | into int
+        let token = '${{ inputs.chat-token }}'
+        let ghToken = '${{ inputs.github-token }}'
+        let sysPrompt = '${{ inputs.sys-prompt }}'
+        let userPrompt = '${{ inputs.user-prompt }}'
         let pr = '${{ github.event.pull_request.number }}'
+        let maxLength = try { '${{ inputs.max-length }}' | into int } catch { 0 }
         (deepseek-review $token
           --model $model
           --repo $repo

meta.json

@@ -1,10 +1,10 @@
 {
     "name": "deepseek-review",
-    "version": "1.2.0",
-    "actionVer": "v1.2",
+    "version": "1.3.0",
+    "actionVer": "v1.3",
     "author": "hustcer",
     "license": "MIT",
     "github": "https://github.com/hustcer/deepseek-review",
-    "home": "https://github.com/marketplace/actions/deepseek-review",
+    "home": "https://github.com/marketplace/actions/deepseek-cr",
     "description": "🚀 Sharpen Your Code, Ship with Confidence – Elevate Your Workflow with Deepseek Code Review 🚀"
 }

nu/review.nu

@@ -38,6 +38,9 @@ const DEFAULT_OPTIONS = {
   SYS_PROMPT: '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.',
 }
 
+# If the PR title or body contains any of these keywords, skip the review
+const IGNORE_REVIEW_KEYWORDS = ['skip review' 'skip cr']
+
 # Use Deepseek AI to review code changes locally or in GitHub Actions
 export def --env deepseek-review [
   token?: string,           # Your Deepseek API token, fallback to CHAT_TOKEN env var
@@ -92,7 +95,7 @@ export def --env deepseek-review [
     print $'(char nl)(ansi r)The content length ($length) exceeds the maximum limit ($max_length), review skipped.(ansi reset)'
     exit $ECODE.SUCCESS
   }
-  print $'Review content length: (ansi g)($length)(ansi reset)'
+  print $'Review content length: (ansi g)($length)(ansi reset), current max length: (ansi g)($max_length)(ansi reset)'
   let payload = {
     model: $model,
     stream: false,
@@ -142,6 +145,12 @@ export def get-diff [
         print $'(ansi r)Please provide the GitHub repository name by `--repo` option.(ansi reset)'
         exit $ECODE.INVALID_PARAMETER
       }
+      # TODO: Ignore keywords checking when triggering by mentioning the bot
+      let description = gh pr view $pr_number --repo $repo --json title,body
+      if ($IGNORE_REVIEW_KEYWORDS | any {|it| $description =~ $it }) {
+        print $'(ansi r)The PR title or body contains keywords to skip the review, bye...(ansi reset)'
+        exit $ECODE.SUCCESS
+      }
       gh pr diff $pr_number --repo $repo | str trim
     } else if ($diff_from | is-not-empty) {
       if not (has-ref $diff_from) {