https://github.com/mys1024/cr-asst-action

An action powered by cr-asst that reviews your pull requests with AI assistants.
https://github.com/mys1024/cr-asst-action

action ai assitant cicd codereview github-actions llm nodejs

Last synced: 30 days ago
JSON representation

An action powered by cr-asst that reviews your pull requests with AI assistants.

• Host: GitHub
• URL: https://github.com/mys1024/cr-asst-action
• Owner: mys1024
• License: mit
• Created: 2025-03-08T15:34:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-08-05T09:34:21.000Z (10 months ago)
• Last Synced: 2025-10-04T21:17:18.289Z (8 months ago)
• Topics: action, ai, assitant, cicd, codereview, github-actions, llm, nodejs
• Language: TypeScript
• Homepage:
• Size: 1.91 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# cr-asst-action

[![license](https://img.shields.io/github/license/mys1024/cr-asst-action)](./LICENSE)

[![version](https://img.shields.io/github/package-json/v/mys1024/cr-asst-action)](https://github.com/mys1024/cr-asst-action/releases)

[![workflow-ci](https://img.shields.io/github/actions/workflow/status/mys1024/cr-asst-action/ci.yml?label=ci)](https://github.com/mys1024/cr-asst-action/actions/workflows/ci.yml)

[![workflow-release](https://img.shields.io/github/actions/workflow/status/mys1024/cr-asst-action/release.yml?label=release)](https://github.com/mys1024/cr-asst-action/actions/workflows/release.yml)

English | [中文](./README.zh.md)

An action powered by **[cr-asst](https://github.com/mys1024/cr-asst)** that reviews your pull requests with AI assistants.

## Usage

1. Create a workflow file `.github/workflows/review-pr.yml` with the following content:

   ```yml

   name: Review PR

   on:

     pull_request:

       types:

         - opened

         - synchronize

       branches:

         - main

   jobs:

     review:

       runs-on: ubuntu-latest

       steps:

         - name: Checkout repository

           uses: actions/checkout@v4

           with:

             fetch-depth: 0

         - name: Review

           uses: mys1024/cr-asst-action@v2

           with:

             github-token: ${{ secrets.GITHUB_TOKEN }} # required

             model: gpt-4 # required

             api-key: ${{ secrets.CR_API_KEY }} # required

             provider: openai # optional, defaults to "openai", options: "openai", "deepseek", "xai", "anthropic", "google"

             base-url: https://api.example.com/v1 # optional

             exclude: 'foo,bar/dir' # optional, defaults to "package-lock.json,pnpm-lock.yaml,yarn.lock"

             prompt-file: 'my-prompt.md' # optional, defaults to the builtin prompt "en"

             output-file: 'review-result.md' # optional

   ```

   Note: see [action.yml](./action.yml) for more details about inputs.

2. Set the secret `CR_API_KEY` in your repository settings.

3. Set the setting `Workflow permissions` to `Read and write permissions` in your repository settings.

## Example

Click [here](https://github.com/mys1024/cr-asst-action/pull/3#issuecomment-2745088468) to see the example.

## License

[MIT](./LICENSE) License © 2025-PRESENT mys1024