@twsc/code-review

@ocis/code-review

This is a program that auto review code changes from gitlab MR by LLM.

Prerequisites

• Node.js >= 12

Install

npm install -g @twsc/code-review

Quick Start

To quick start the code review, run the following command:

code-review start <options>

Where are:

• --host: llm host (default is openai api url)
• --llmToken: llm api token (You can also set environment variables LLM_TOKEN)
• --gitlabToken: gitlab api token (You can also set environment variables GITLAB_TOKEN)
• --mr: gitlab mr url
• --model: llm model (default is "gpt-4o")
• --language: llm language (default is "Traditional Chinese")
• --automode: Automatic mode does not do Q&A (default is "0")
• --reviewmode: Review mode select, can choose "debug" or "suggestion" (default is "debug")
• --temperature: LLM temperature (default is "1")
• --top_k: LLM top_k (default is "1")
• --top_p: LLM top_p (default is "1")

Usage on gitlab CI/CD

Step 1:

Setting gitlab CI/CD variables

• GITLAB_TOKEN
• LLM_HOST
• LLM_TOKEN
• LLM_MODEL

Step 2:

Update gitlab.ci

stages:
  - auto-code-review

auto-code-review:
  stage: auto-code-review
  image: node:18-alpine
  script:
    - npm install -g @twsc/code-review
    - code-review start --automode 1 --host ${LLM_HOST} --model ${LLM_MODEL} --mr ${CI_PROJECT_URL}/-/merge_requests/${CI_MERGE_REQUEST_IID}
  tags:
    - normal
  rules:
    - if: $CI_MERGE_REQUEST_ID
      changes: *change_list
      when: manual