Bump v1.5.1

* feat: Add awk regex generator custom commands

* feat: Add include and exlude for file pattern filter support

.env.example

@@ -0,0 +1,32 @@
+# Description: Environment variables for Local Code Review Only
+# Usage: Copy this file to .env and replace the values with your own
+# WARNING: Do not commit the actual .env file to version control as it may contain sensitive information.
+
+# CHAT_TOKEN: Obtain this token from your Deepseek account settings
+CHAT_TOKEN='Your Deepseek API token'
+# GITHUB_TOKEN: Your GitHub API token to query GitHub PR changes
+# Generate this token from your GitHub account with the necessary permissions
+GITHUB_TOKEN='Your GitHub API token'
+# MAX_LENGTH: The maximum length of the content for review, 0 means no limit.
+MAX_LENGTH='0'
+# The comma separated file patterns to include in the code review.
+INCLUDE_PATTERNS=''
+# The comma separated file patterns to exclude in the code review.
+EXCLUDE_PATTERNS='pnpm-lock.yaml,package-lock.json,*.lock'
+# Default GitHub repository name to fetch PR changes
+DEFAULT_GITHUB_REPO='hustcer/deepseek-review'
+# Default local repository absolute path to query commit changes
+DEFAULT_LOCAL_REPO='/Users/hustcer/deepseek-review'
+# BASE_URL: Deepseek API base URL
+# Replace with the actual API base URL if different
+BASE_URL='https://api.deepseek.ai'
+# USER_PROMPT: User prompt message, customize as needed
+# OR a yaml file path with key name specified to load the prompt message,
+# e.g., USER_PROMPT='/User/abc/prompts.yaml:usr-prompt'
+# Will load the prompt message from the 'usr-prompt' key in the 'prompts.yaml' file
+USER_PROMPT='Please review the following code changes'
+# SYSTEM_PROMPT: System prompt message, customize as needed
+# OR a yaml file path with key name specified to load the prompt message,
+# e.g., SYSTEM_PROMPT='/User/abc/prompts.yaml:sys-prompt'
+# Will load the prompt message from the 'sys-prompt' key in the 'prompts.yaml' file
+SYSTEM_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.'

.github/workflows/basic.yml

@@ -1,25 +0,0 @@
-# Description:
-#   - Deepseek code review with GitHub Actions
-# REF:
-#   - https://github.com/marketplace/actions/checkout
-
-name: Code Review
-on:
-  pull_request_target:
-    types: [opened, synchronize, reopened]
-
-# fix: GraphQL: Resource not accessible by integration (addComment) error
-permissions:
-  pull-requests: write
-
-jobs:
-  setup-deepseek-review:
-    strategy:
-      fail-fast: false
-    runs-on: ubuntu-latest
-    name: Code Review
-    steps:
-      - name: Deepseek Code Review
-        uses: hustcer/deepseek-review@develop
-        with:
-          deepseek-token: ${{ secrets.DEEPSEEK_TOKEN }}

.github/workflows/cr.yml

@@ -0,0 +1,99 @@
+# Description:
+#   - Deepseek code review with GitHub Actions
+
+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
+      # - 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: macos-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@develop
+        with:
+          max-length: 15000
+          # Store the chat token in GitHub Secrets, don't expose it in the workflow file
+          chat-token: ${{ secrets.CHAT_TOKEN }}
+          sys-prompt: >
+            As a senior DevOps engineer, perform comprehensive review of shell scripts with focus on:
+
+            1. Core Requirements:
+            - Validate POSIX compatibility
+            - Check for proper error handling
+            - Verify safe variable usage
+            - Assess resource management
+
+            2. Security Analysis:
+            - Shell injection prevention
+            - Safe file operations
+            - Proper permissions handling
+            - Secure command execution
+
+            3. Performance Optimization:
+            - Efficient process management
+            - Proper use of subshells
+            - Stream handling best practices
+            - Avoidance of unnecessary forks
+
+            Rules:
+            - Target bash/sh compatibility
+            - Highlight security vulnerabilities
+            - Suggest performance improvements
+            - Keep feedback actionable
+            - Use technical shell terminology
+
+            Required output structure:
+            #### Script Analysis
+            - Key observations
+
+            #### Security Review
+            - Vulnerability findings
+
+            #### Optimization Suggestions
+            - Performance improvements
+
+            **Overall Quality:** Rating (1-5)
+
+            Use the following reference data:
+            ```yaml
+            checklist:
+              - Compatibility: ["POSIX compliance", "Shell-specific features", "Portability"]
+              - Security: ["Input validation", "Safe eval usage", "Permission checks"]
+              - Reliability: ["Error handling", "Exit codes", "Signal trapping"]
+              - Performance: ["Process management", "I/O operations", "Subshell usage"]
+
+            examples:
+              - issue: "❗ Unquoted variable expansion in line 42 (shell injection risk)"
+              - issue: "⚠️ Missing error handling for rm operation in line 15"
+              - suggestion: "Replace backticks with $() for better readability and nesting"
+              - suggestion: "Use exec for file handling to reduce file descriptors"
+
+            response_template: |
+              #### Script Analysis
+              - {{observations}}
+
+              {{#security_issues}}
+              #### Security Review
+              - {{security_issues}}
+              {{/security_issues}}
+
+              {{#optimizations}}
+              #### Optimization Suggestions
+              - {{optimizations}}
+              {{/optimizations}}
+
+              **Overall Quality:** {{rating}}
+            ```

.gitignore

@@ -1 +1,2 @@
 .env
+prompts.yaml

CHANGELOG.md

@@ -1,6 +1,89 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.5.1] - 2025-02-01
+
+### Bug Fixes
+
+- Fix `awk` error on `macOS` runner (#71)
+
+## [1.5.0] - 2025-02-01
+
+### Documentation
+
+- Update README (#61)
+
+### Features
+
+- Add example of triggering code review by adding `ai review` label (#60)
+- Load multi-line prompts from yaml config for local code reviewing (#67)
+- Add `include` and `exclude` for file pattern filtering support (#68)
+
+### Miscellaneous Tasks
+
+- Update prompts for current repo's workflow (#63)
+
+### Refactor
+
+- Extracted git repo check into `is-repo` custom command (#64)
+
+## [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
+
+- Change `DEEPSEEK_TOKEN` to `CHAT_TOKEN` (#50)
+
+### Features
+
+- Add `max-length` input (#52)
+
+### Miscellaneous Tasks
+
+- Update action name, description and icon (#49)
+
+## [1.1.0] - 2025-01-30
+
+### Bug Fixes
+
+- Do not override `GITHUB_TOKEN` env var (#30)
+- Check `gh` installation status in GitHub Action (#31)
+- Add git repo and git ref checking (#32)
+- Add repo checking for GitHub PR review (#34)
+- Polish CLI output for local code review (#44)
+
+### Documentation
+
+- Add features description to README (#29)
+- Add CLI help doc (#36)
+- Add planed features to doc (#39)
+- Add local code review guide (#41)
+
+### Features
+
+- Add dot env conf for local code review (#33)
+- Add more CLI short flags (#35)
+- Add `DEFAULT_GITHUB_REPO` & `DEFAULT_LOCAL_REPO` config for local code review (#42)
+
+### Miscellaneous Tasks
+
+- Use `v1` in README docs (#17)
+
 ## [1.0.0] - 2025-01-29
 
 ### Bug Fixes

README.md

@@ -2,13 +2,35 @@
 
 [中文说明](README.zh-CN.md)
 
+## Features
+
+- 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`.
+
+## Planned Features
+
+- [ ] **Trigger Code Review on Mention**: Automatically initiate code review when the `github-actions` bot is mentioned in a PR comment.
+
 ## Code Review with GitHub Action
 
+### Initiate Code Review When PR was Created
+
+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:
@@ -20,22 +42,74 @@ jobs:
     name: Code Review
     steps:
       - name: Deepseek Code Review
-        uses: hustcer/deepseek-review@develop
+        uses: hustcer/deepseek-review@v1
         with:
-          deepseek-token: ${{ secrets.DEEPSEEK_TOKEN }}
+          chat-token: ${{ secrets.CHAT_TOKEN }}
 ```
 
+<details>
+  <summary>CHAT_TOKEN Config</summary>
+
+  Follow these steps to config your `CHAT_TOKEN`:
+
+  - Click on the "Settings" tab in your repository navigation bar.
+  - In the left sidebar, click on "Secrets and variables" under "Security".
+  - Click on "Actions" -> "New repository secret" button.
+  - Enter `CHAT_TOKEN` in the "Name" field.
+  - Enter the value of your `CHAT_TOKEN` in the "Secret" field.
+  - Finally, click the "Add secret" button to save the secret.
+
+</details>
+
+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](https://github.com/hustcer/deepseek-review/pull/30) with [default prompts](https://github.com/hustcer/deepseek-review/blob/main/action.yaml#L35) & [Run Log](https://github.com/hustcer/deepseek-review/actions/runs/13043609677/job/36390331791#step:2:53).
+- [Example 2](https://github.com/hustcer/deepseek-review/pull/68) with [this prompt](https://github.com/hustcer/deepseek-review/blob/eba892d969049caff00b51a31e5c093aeeb536e3/.github/workflows/cr.yml#L32)
+
+### Trigger CR When a Specific Label was Added
+
+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:
+
+```yaml
+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.
+
 ## Input Parameters
 
 | Name           | Type   | Description                                                             |
 | -------------- | ------ | ----------------------------------------------------------------------- |
-| deepseek-token | String | Required, Deepseek API Token                                            |
+| 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` |
-| sys-prompt     | String | Optional, system prompt corresponding to `$sys_prompt` in the input, default value see note below |
-| user-prompt    | String | Optional, system prompt corresponding to `$user_prompt` in the input, default value see note below |
+| 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 |
+| include-patterns | String | Optional, The comma separated file patterns to include in the code review. No default |
+| exclude-patterns | String | Optional, The comma separated file patterns to exclude in the code review. Default to `pnpm-lock.yaml,package-lock.json,*.lock` |
+| github-token   | String | Optional, The `GITHUB_TOKEN` secret or personal access token to authenticate. Defaults to `github.token`. |
 
-**API Call Input**:
+**Deepseek API Call Payload**:
 
 ```js
 {
@@ -55,6 +129,74 @@ jobs:
 }
 ```
 
+> [!NOTE]
+>
+> You can control the language of the code review results by the language of the
+> Prompt. The default Prompt language is currently English. When you use a Chinese
+> Prompt, the generated code review results will be in Chinese.
+
+## Local Code Review
+
+### Required 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 locally or in GitHub Actions
+
+Usage:
+  > deepseek-review {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)
+
+```
+
+### Environment Configuration
+
+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.
+
+> [!WARNING]
+>
+> The `.env` configuration file is only used locally and will not be utilized in GitHub
+> Workflow. Please securely store any sensitive information in it and avoid committing
+> it to the code repository.
+
+### Usage Examples
+
+```sh
+# Perform code review on the `git diff` changes in the local DEFAULT_LOCAL_REPO repo
+just cr
+# Perform code review on the `git diff f536acc` changes in the local DEFAULT_LOCAL_REPO repo
+just cr --diff-from f536acc
+# Perform code review on the `git diff f536acc 0dd0eb5` changes in the local DEFAULT_LOCAL_REPO repo
+just cr --diff-from f536acc --diff-to 0dd0eb5
+# Perform code review on PR #31 in the remote DEFAULT_GITHUB_REPO repo
+just cr --pr-number 31
+# Perform code review on PR #31 in the remote hustcer/deepseek-review repo
+just cr --pr-number 31 --repo hustcer/deepseek-review
+```
+
 ## License
 
 Licensed under:

README.zh-CN.md

@@ -1,12 +1,34 @@
-# Deepseek Code Review
+# Deepseek 代码审查
 
-## 通过 GitHub Action 进行代码审核
+## 特性
+
+- 通过 GitHub Action 使用 Deepseek 进行自动化 PR 审查
+- 通过本地 CLI 直接审查远程 GitHub PR
+- 通过本地 CLI 使用 Deepseek 分析任何本地仓库的提交变更
+- 完全可定制：选择模型、基础 URL 和提示词
+- 支持自托管 Deepseek 模型，提供更强的灵活性
+- 在 PR 的标题或描述中添加 `skip cr` or `skip review` 可跳过 GitHub Actions 里的代码审查
+- 对指定文件变更进行包含/排除式代码审查
+- 跨平台：支持 GitHub `macOS`, `Ubuntu` & `Windows` Runners
+
+## 计划支持特性
+
+- [ ] **通过提及触发代码审查**：当 PR 评论中提及 `github-actions bot` 时，自动触发代码审查
+
+## 通过 GitHub Action 进行代码审查
+
+### 创建 PR 时自动触发代码审查
+
+创建一个 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:
@@ -18,22 +40,74 @@ jobs:
     name: Code Review
     steps:
       - name: Deepseek Code Review
-        uses: hustcer/deepseek-review@develop
+        uses: hustcer/deepseek-review@v1
         with:
-          deepseek-token: ${{ secrets.DEEPSEEK_TOKEN }}
+          chat-token: ${{ secrets.CHAT_TOKEN }}
 ```
 
+<details>
+  <summary>CHAT_TOKEN 配置</summary>
+
+  按照以下步骤配置你的 `CHAT_TOKEN`：
+
+  1. 点击仓库导航栏中的 "Settings" 选项卡
+  2. 在左侧边栏中，点击 "Security" 下的 "Secrets and variables"
+  3. 点击 "Actions" -> "New repository secret" 按钮
+  4. 在 "Name" 字段中输入 `CHAT_TOKEN`
+  5. 在 "Secret" 字段中输入你的 `CHAT_TOKEN` 值
+  6. 最后，点击 "Add secret"按钮保存密钥
+
+</details>
+
+当 PR 创建的时候会自动触发 Deepseek 代码审查，并将审查结果（依赖于提示词）以评论的方式发布到对应的 PR 上。比如：
+- [示例 1](https://github.com/hustcer/deepseek-review/pull/30) 基于[默认提示词](https://github.com/hustcer/deepseek-review/blob/main/action.yaml#L35) & [运行日志](https://github.com/hustcer/deepseek-review/actions/runs/13043609677/job/36390331791#step:2:53).
+- [示例 2](https://github.com/hustcer/deepseek-review/pull/68) 基于[这个提示词](https://github.com/hustcer/deepseek-review/blob/eba892d969049caff00b51a31e5c093aeeb536e3/.github/workflows/cr.yml#L32)
+
+### 当 PR 添加指定 Label 时触发审查
+
+如果你不希望创建 PR 时自动审查可以选择通过添加标签时触发代码审查，比如创建如下 Workflow：
+
+```yaml
+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 }}
+```
+
+如此以来当 PR 创建的时候不会自动触发 Deepseek 代码审查，只有你手工添加 `ai review` 标签的时候才会触发审查。
+
 ## 输入参数
 
 | 名称           | 类型   | 描述                                                           |
 | -------------- | ------ | -------------------------------------------------------------- |
-| deepseek-token | String | 必填，Deepseek API Token                                       |
-| model          | String | 可选，配置代码审核选用的模型，默认为 `deepseek-chat`           |
+| chat-token     | String | 必填，Deepseek API Token                                       |
+| model          | String | 可选，配置代码审查选用的模型，默认为 `deepseek-chat`           |
 | base-url       | String | 可选，Deepseek API Base URL, 默认为 `https://api.deepseek.com` |
-| sys-prompt     | String | 可选，系统 Prompt 对应入参中的 `$sys_prompt`, 默认值见后文注释      |
-| user-prompt    | String | 可选，用户 Prompt 对应入参中的 `$user_prompt`, 默认值见后文注释     |
+| max-length     | Int    | 可选，待审查内容的最大 Unicode 长度, 默认 `0` 表示没有限制，超过非零值则跳过审查 |
+| sys-prompt     | String | 可选，系统提示词对应入参中的 `$sys_prompt`, 默认值见后文注释      |
+| user-prompt    | String | 可选，用户提示词对应入参中的 `$user_prompt`, 默认值见后文注释     |
+| include-patterns | String | 可选，代码审查中要包含的以逗号分隔的文件模式，无默认值 |
+| exclude-patterns | String | 可选，代码审查中要排除的以逗号分隔的文件模式，默认值为 `pnpm-lock.yaml,package-lock.json,*.lock` |
+| github-token   | String | 可选，用于访问 API 进行 PR 管理的 GitHub Token，默认为 `${{ github.token }}` |
 
-接口调用入参:
+Deepseek 接口调用入参:
 
 ```js
 {
@@ -53,6 +127,72 @@ jobs:
 }
 ```
 
+> [!NOTE]
+>
+> 可以通过提示词的语言来控制代码审查结果的语言，当前默认的提示词语言是英文的，
+> 当你使用中文提示词的时候生成的代码审查结果就是中文的
+
+## 本地代码审查
+
+### 依赖工具
+
+在本地进行代码审查，支持 `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 locally or in GitHub Actions
+
+Usage:
+  > deepseek-review {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)
+
+```
+
+### 环境配置
+
+在本地进行代码审查需要先修改配置文件，仓库里已经有了 `.env.example` 配置文件示例，将其拷贝到 `.env` 然后根据自己的实际情况进行修改即可。
+
+> [!WARNING]
+>
+> `.env` 配置文件仅在本地使用，在 GitHub Workflow 里面不会使用，里面的敏感信息请
+> 妥善保存，不要提交到代码仓库里面
+
+### 使用举例
+
+```sh
+# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff` 修改内容进行代码审查
+just cr
+# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc` 修改内容进行代码审查
+just cr --diff-from f536acc
+# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc 0dd0eb5` 修改内容进行代码审查
+just cr --diff-from f536acc --diff-to 0dd0eb5
+# 对远程 DEFAULT_GITHUB_REPO 仓库编号为 31 的 PR 进行代码审查
+just cr --pr-number 31
+# 对远程 hustcer/deepseek-review 仓库编号为 31 的 PR 进行代码审查
+just cr --pr-number 31 --repo hustcer/deepseek-review
+```
+
 ## 许可
 
 Licensed under:

action.yaml

@@ -6,18 +6,22 @@
 #   - https://docs.github.com/cn/actions/creating-actions/metadata-syntax-for-github-actions
 #   - https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
 
-name: 'Deepseek Code Review'
+name: 'Deepseek CR'
 author: 'hustcer'
-description: 'A github action to do code review by Deepseek for PRs.'
+description: '🚀 Sharpen Your Code, Ship with Confidence – Elevate Your Workflow with Deepseek Code Review 🚀'
 
 branding:
-  icon: 'code'
+  icon: 'eye'
   color: 'purple'
 
 inputs:
-  deepseek-token:
+  chat-token:
     required: true
     description: 'Your deepseek API token.'
+  max-length:
+    default: 0
+    required: false
+    description: 'The maximum length of the content for review, 0 means no limit.'
   model:
     required: false
     default: 'deepseek-chat'
@@ -34,6 +38,17 @@ inputs:
     required: false
     default: 'Please review the following code changes'
     description: 'The user prompt for deepseek API.'
+  include-patterns:
+    required: false
+    description: 'The comma separated file patterns to include in the code review.'
+  exclude-patterns:
+    required: false
+    default: 'pnpm-lock.yaml,package-lock.json,*.lock'
+    description: 'The comma separated file patterns to exclude in the code review.'
+  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'
@@ -48,21 +63,27 @@ runs:
       run: |
         const NU_LIB_DIRS = [ ${{ github.action_path }}/nu ]
         use review.nu *
-        let model = '${{inputs.model}}'
-        let baseUrl = '${{inputs.base-url}}'
-        let token = '${{inputs.deepseek-token}}'
-        let sysPrompt = '${{inputs.sys-prompt}}'
-        let userPrompt = '${{inputs.user-prompt}}'
-        let ghToken = '${{ github.token }}'
+        let model = '${{ inputs.model }}'
+        let baseUrl = '${{ inputs.base-url }}'
         let repo = '${{ github.repository }}'
+        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 includePatterns = '${{ inputs.include-patterns }}'
+        let excludePatterns = '${{ inputs.exclude-patterns }}'
+        let maxLength = try { '${{ inputs.max-length }}' | into int } catch { 0 }
         (deepseek-review $token
           --model $model
           --repo $repo
           --pr-number $pr
           --gh-token $ghToken
           --base-url $baseUrl
+          --max-length $maxLength
           --sys-prompt $sysPrompt
           --user-prompt $userPrompt
+          --include $includePatterns
+          --exclude $excludePatterns
         )
 

cliff.toml

@@ -39,6 +39,7 @@ commit_parsers = [
     { message = "^doc", group = "Documentation"},
     { message = "^perf", group = "Performance"},
     { message = "^refactor", group = "Refactor"},
+    { message = "^breaking", group = "Breaking Changes"},
     { message = "^style", group = "Styling"},
     { message = "^test", group = "Testing"},
     { message = "^chore\\(release\\): prepare for", skip = true},

cspell.yml

@@ -4,11 +4,16 @@
 #   npx cspell --no-progress .
 
 words:
+- psql
+- ECODE
+- endfor
+- dotenv
+- hustcer
+- Nushell
 - justfile
 - lefthook
 - deepseek
-- hustcer
-- endfor
-- dotenv
 - linewise
+- Subshell
+- subshells
 ignorePaths:

meta.json

@@ -1,10 +1,10 @@
 {
     "name": "deepseek-review",
-    "version": "1.0.0",
-    "actionVer": "v1.0",
+    "version": "1.5.1",
+    "actionVer": "v1.5.1",
     "author": "hustcer",
     "license": "MIT",
     "github": "https://github.com/hustcer/deepseek-review",
-    "home": "https://github.com/marketplace/actions/deepseek-review",
-    "description": "A github action to do code review for pull requests."
+    "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

@@ -2,19 +2,35 @@
 # Author: hustcer
 # Created: 2025/01/29 13:02:15
 # TODO:
-#   [√] Deepseek code review for GitHub PRs
-#   [√] Deepseek code review for local commit changes
-#   [√] Debug mode
-#   [√] Output token usage info
-#   [ ] Add more action outputs
+#  [√] Deepseek code review for GitHub PRs
+#  [√] Deepseek code review for local commit changes
+#  [√] Debug mode
+#  [√] Output token usage info
+#  [√] Perform CR for changes that either include or exclude specific files
+#  [ ] Add more action outputs
 # Description: A script to do code review by deepseek
 # Env vars:
 #  GITHUB_TOKEN: Your GitHub API token
-#  DEEPSEEK_TOKEN: Your Deepseek API token
+#  CHAT_TOKEN: Your Deepseek API token
+#  BASE_URL: Deepseek API base URL
+#  SYSTEM_PROMPT: System prompt message
+#  USER_PROMPT: User prompt message
 # Usage:
-#  1. Local: just cr
-#  2. Local: just cr -f HEAD~1 --debug
-#
+#  - Local Repo Review: just cr
+#  - Local Repo Review: just cr -f HEAD~1 --debug
+#  - Local PR Review: just cr -r hustcer/deepseek-review -n 32
+
+# Commonly used exit codes
+const ECODE = {
+  SUCCESS: 0,
+  OUTDATED: 1,
+  MISSING_BINARY: 2,
+  MISSING_DEPENDENCY: 3,
+  CONDITION_NOT_SATISFIED: 5,
+  SERVER_ERROR: 6,
+  INVALID_PARAMETER: 7,
+  AUTH_FAILED: 8,
+}
 
 const DEFAULT_OPTIONS = {
   MODEL: 'deepseek-chat',
@@ -23,76 +39,95 @@ 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.',
 }
 
-# Use Deepseek AI to review code changes
-export def deepseek-review [
-  token?: string,       # Your Deepseek API token, fallback to DEEPSEEK_TOKEN
-  --debug(-d),          # Debug mode
-  --repo: string,       # GitHub repository name, e.g. hustcer/deepseek-review
-  --pr-number: string,  # GitHub PR number
-  --gh-token: string,   # Your GitHub token, GITHUB_TOKEN by default
-  --diff-to(-t): string,       # Diff to git ref
-  --diff-from(-f): string,     # Diff from git ref
-  --model: string = $DEFAULT_OPTIONS.MODEL,   # Model name, deepseek-chat by default
-  --base-url: string = $DEFAULT_OPTIONS.BASE_URL,
-  --sys-prompt: string = $DEFAULT_OPTIONS.SYS_PROMPT,
-  --user-prompt: string = $DEFAULT_OPTIONS.USER_PROMPT,
-] {
+# If the PR title or body contains any of these keywords, skip the review
+const IGNORE_REVIEW_KEYWORDS = ['skip review' 'skip cr']
 
-  let token = $token | default $env.DEEPSEEK_TOKEN?
+# 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
+  --debug(-d),              # Debug mode
+  --repo(-r): string,       # GitHub repository name, e.g. hustcer/deepseek-review
+  --pr-number(-n): string,  # GitHub PR number
+  --gh-token(-k): string,   # Your GitHub token, fallback to GITHUB_TOKEN env var
+  --diff-to(-t): string,    # Diff to git REF
+  --diff-from(-f): string,  # Diff from git REF
+  --max-length(-l): int,    # Maximum length of the content for review, 0 means no limit.
+  --model(-m): string = $DEFAULT_OPTIONS.MODEL,   # Model name, deepseek-chat by default
+  --base-url(-b): string = $DEFAULT_OPTIONS.BASE_URL,
+  --sys-prompt(-s): string  # Default to $DEFAULT_OPTIONS.SYS_PROMPT,
+  --user-prompt(-u): string # Default to $DEFAULT_OPTIONS.USER_PROMPT,
+  --include(-i): string,    # Comma separated file patterns to include in the code review
+  --exclude(-x): string,    # Comma separated file patterns to exclude in the code review
+]: nothing -> nothing {
+  $env.config.table.mode = 'psql'
+  let is_action = ($env.GITHUB_ACTIONS? == 'true')
+  let token = $token | default $env.CHAT_TOKEN?
+  let repo = $repo | default $env.DEFAULT_GITHUB_REPO?
+  let header = [Authorization $'Bearer ($token)']
+  let url = $'($base_url)/chat/completions'
+  let local_repo = $env.DEFAULT_LOCAL_REPO? | default (pwd)
+  let max_length = $max_length | default ($env.MAX_LENGTH? | default 0 | into int)
+  let setting = {
+    repo: $repo,
+    include: $include,
+    exclude: $exclude,
+    diff_to: $diff_to,
+    diff_from: $diff_from,
+    pr_number: $pr_number,
+    max_length: $max_length,
+    local_repo: $local_repo,
+  }
   $env.GH_TOKEN = $gh_token | default $env.GITHUB_TOKEN?
   if ($token | is-empty) {
-    print $'(ansi r)Please provide your Deepseek API token by setting `DEEPSEEK_TOKEN` or passing it as an argument.(ansi reset)'
-    return
+    print $'(ansi r)Please provide your Deepseek API token by setting `CHAT_TOKEN` or passing it as an argument.(ansi reset)'
+    exit $ECODE.INVALID_PARAMETER
   }
-  let hint = if ($env.GITHUB_ACTIONS? != 'true') {
+  if $is_action and not (is-installed gh) {
+    print $'(ansi r)Please install GitHub CLI from https://cli.github.com (ansi reset)'
+    exit $ECODE.MISSING_BINARY
+  }
+  let hint = if not $is_action and ($pr_number | is-empty) {
     $'🚀 Initiate the code review by Deepseek AI for local changes ...'
   } else {
     $'🚀 Initiate the code review by Deepseek AI for PR (ansi g)#($pr_number)(ansi reset) in (ansi g)($repo)(ansi reset) ...'
   }
   print $hint; print -n (char nl)
-  $env.GITHUB_TOKEN = $gh_token | default $env.GITHUB_TOKEN?
-  let diff_content = if ($pr_number | is-not-empty) {
-      gh pr diff $pr_number --repo $repo | str trim
-    } else if ($diff_from | is-not-empty) {
-      git diff $diff_from ($diff_to | default HEAD)
-    } else { git diff }
-  if ($diff_content | is-empty) {
-    print $'(ansi r)Please provide the diff content by passing `--pr-number`.(ansi reset)'
-    return
+  if ($pr_number | is-empty) { $setting | compact-record | reject repo | print }
+
+  let content = (
+    get-diff --pr-number $pr_number --repo $repo --diff-to $diff_to
+             --diff-from $diff_from --include $include --exclude $exclude)
+  let length = $content | str stats | get unicode-width
+  if ($max_length != 0) and ($length > $max_length) {
+    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), current max length: (ansi g)($max_length)(ansi reset)'
+  let sys_prompt = $sys_prompt | default (load-prompt-from-env SYSTEM_PROMPT) | default $DEFAULT_OPTIONS.SYS_PROMPT
+  let user_prompt = $user_prompt | default (load-prompt-from-env USER_PROMPT) | default $DEFAULT_OPTIONS.USER_PROMPT
   let payload = {
     model: $model,
     stream: false,
     messages: [
       { role: 'system', content: $sys_prompt },
-      { role: 'user', content: $"($user_prompt):\n($diff_content)" }
+      { role: 'user', content: $"($user_prompt):\n($content)" }
     ]
   }
-  if $debug {
-    print $'Code Changes:'; hr-line; print $diff_content
-  }
-  let header = [Authorization $'Bearer ($token)']
-  let url = $'($base_url)/chat/completions'
+  if $debug { print $'Code Changes:'; hr-line; print $content }
   print $'(char nl)(ansi g)Waiting for response from Deepseek ...(ansi reset)'
   let response = http post -e -H $header -t application/json $url $payload
   if ($response | is-empty) {
     print $'(ansi r)Oops, No response returned from Deepseek API.(ansi reset)'
-    exit 1
-    return
-  }
-  if $debug {
-    print $'Deepseek Response:'; hr-line
-    $response | table -e | print
+    exit $ECODE.SERVER_ERROR
   }
+  if $debug { print $'Deepseek Response:'; hr-line; $response | table -e | print }
   if ($response | describe) == 'string' {
     print $'❌ Code review failed！Error: '; hr-line; print $response
-    exit 1
-    return
+    exit $ECODE.SERVER_ERROR
   }
   let review = $response | get -i choices.0.message.content
-  if ($env.GITHUB_ACTIONS? != 'true') {
-    print $'Code Review Result:'; hr-line
-    print $review
+  if not $is_action {
+    print $'Code Review Result:'; hr-line; print $review
   } else {
     gh pr comment $pr_number --body $review --repo $repo
     print $'✅ Code review finished！PR (ansi g)#($pr_number)(ansi reset) review result was posted as a comment.'
@@ -101,16 +136,148 @@ export def deepseek-review [
   $response.usage | table -e | print
 }
 
+# Load the prompt content from the specified env var
+export def load-prompt-from-env [
+  prompt_key: string,
+] {
+  let prompt = $env | get -i $prompt_key | default ''
+  if $prompt =~ '.yaml' {
+    let key = $prompt | split row : | last
+    let path = $prompt | split row : | first
+    try { open $path | get -i $key } catch {
+      print $'(ansi r)Failed to load the prompt content from ($path), please check it again.(ansi reset)'
+      exit $ECODE.INVALID_PARAMETER
+    }
+  } else { $prompt }
+}
+
+# Get the diff content from GitHub PR or local git changes
+export def get-diff [
+  --repo: string,       # GitHub repository name
+  --pr-number: string,  # GitHub PR number
+  --diff-to: string,    # Diff to git ref
+  --diff-from: string,  # Diff from git ref
+  --include: string,    # Comma separated file patterns to include in the code review
+  --exclude: string,    # Comma separated file patterns to exclude in the code review
+] {
+  let local_repo = $env.DEFAULT_LOCAL_REPO? | default (pwd)
+  if not ($local_repo | path exists) {
+    print $'(ansi r)The directory ($local_repo) does not exist.(ansi reset)'
+    exit $ECODE.CONDITION_NOT_SATISFIED
+  }
+  cd $local_repo
+  mut content = if ($pr_number | is-not-empty) {
+      if ($repo | is-empty) {
+        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) {
+        print $'(ansi r)The specified git ref ($diff_from) does not exist, please check it again.(ansi reset)'
+        exit $ECODE.INVALID_PARAMETER
+      }
+      if ($diff_to | is-not-empty) and not (has-ref $diff_to) {
+        print $'(ansi r)The specified git ref ($diff_to) does not exist, please check it again.(ansi reset)'
+        exit $ECODE.INVALID_PARAMETER
+      }
+      git diff $diff_from ($diff_to | default HEAD)
+    } else if not (git-check $local_repo --check-repo=1) {
+      print $'Current directory ($local_repo) is (ansi r)NOT(ansi reset) a git repo, bye...(char nl)'
+      exit $ECODE.CONDITION_NOT_SATISFIED
+    } else { git diff }
+
+  if ($content | is-empty) {
+    print $'(ansi g)Nothing to review.(ansi reset)'; exit $ECODE.SUCCESS
+  }
+  let awk_bin = (prepare-awk)
+  if ($include | is-not-empty) {
+    let patterns = $include | split row ','
+    $content = $content | ^$awk_bin (generate-include-regex $patterns)
+  }
+  if ($exclude | is-not-empty) {
+    let patterns = $exclude | split row ','
+    $content = $content | ^$awk_bin (generate-exclude-regex $patterns)
+  }
+  $content
+}
+
+# Prepare gawk for macOS
+export def prepare-awk [] {
+  if (is-installed awk) {
+    print $'Current awk version: (awk --version | lines | first)'
+  }
+  if ($env.GITHUB_ACTIONS? != 'true') { return 'awk' }
+  if (sys host | get name) == 'Darwin' {
+    brew install gawk
+    print $'Current gawk version: (gawk --version | lines | first)'
+  }
+  'gawk'
+}
+
+# Compact the record by removing empty columns
+export def compact-record []: record -> record {
+  let record = $in
+  let empties = $record | columns | filter {|it| $record | get $it | is-empty }
+  $record | reject ...$empties
+}
+
 # Check if some command available in current shell
 export def is-installed [ app: string ] {
   (which $app | length) > 0
 }
 
+# Check if git was installed and if current directory is a git repo
+export def git-check [
+  dest: string,        # The dest dir to check
+  --check-repo: int,   # Check if current directory is a git repo
+] {
+  cd $dest
+  if not (is-installed git) {
+    print $'You should (ansi r)INSTALL git(ansi reset) first to run this command, bye...'
+    exit $ECODE.MISSING_BINARY
+  }
+  # If we don't need repo check just quit now
+  if ($check_repo != 0) {
+    if not (is-repo) {
+      print $'Current directory is (ansi r)NOT(ansi reset) a git repo, bye...(char nl)'
+      exit $ECODE.CONDITION_NOT_SATISFIED
+    }
+  }
+  true
+}
+
+# Check if current directory is a git repo
+export def is-repo [] {
+  let checkRepo = try {
+      do -i { git rev-parse --is-inside-work-tree } | complete
+    } catch {
+      ({ stdout: 'false' })
+    }
+  if ($checkRepo.stdout =~ 'true') { true } else { false }
+}
+
+# Check if a git repo has the specified ref: could be a branch or tag, etc.
+export def has-ref [
+  ref: string   # The git ref to check
+] {
+  if not (is-repo) { return false }
+  # Brackets were required here, or error will occur
+  let parse = (do -i { git rev-parse --verify -q $ref } | complete)
+  if ($parse.stdout | is-empty) { false } else { true }
+}
+
 export def hr-line [
   width?: int = 90,
-  --color(-c): string = 'g',
   --blank-line(-b),
   --with-arrow(-a),
+  --color(-c): string = 'g',
 ] {
   # Create a line by repeating the unit with specified times
   def build-line [
@@ -124,4 +291,16 @@ export def hr-line [
   if $blank_line { char nl }
 }
 
+# Generate the awk include regex pattern string for the specified patterns
+export def generate-include-regex [patterns: list<string>] {
+  let pattern = $patterns | each {|pat| $pat | str replace '/' '\/' } | str join '|'
+  $"/^diff --git/{p=/^diff --git a\\/($pattern)/}p"
+}
+
+# Generate the awk exclude regex pattern string for the specified patterns
+def generate-exclude-regex [patterns: list<string>] {
+  let pattern = $patterns | each {|pat| $pat | str replace '/' '\/' } | str join '|'
+  $"/^diff --git/{p=/^diff --git a\\/($pattern)/}!p"
+}
+
 alias main = deepseek-review