{"id":13626383,"url":"https://github.com/gvasilei/AutoReviewer","last_synced_at":"2025-04-16T14:33:29.182Z","repository":{"id":165481846,"uuid":"634801034","full_name":"gvasilei/AutoReviewer","owner":"gvasilei","description":"Use LLMs to perform automatic code reviews.","archived":false,"fork":false,"pushed_at":"2024-06-24T17:49:02.000Z","size":3051,"stargazers_count":40,"open_issues_count":7,"forks_count":14,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-02T01:01:32.147Z","etag":null,"topics":["ai","chatgpt","codereview","effect-ts","github-actions","gpt","langchain","llm","openai"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gvasilei.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-01T08:21:48.000Z","updated_at":"2024-09-16T12:17:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"300765a8-3448-40e7-a8bf-3edcfb46e6d3","html_url":"https://github.com/gvasilei/AutoReviewer","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvasilei%2FAutoReviewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvasilei%2FAutoReviewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvasilei%2FAutoReviewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gvasilei%2FAutoReviewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gvasilei","download_url":"https://codeload.github.com/gvasilei/AutoReviewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223716505,"owners_count":17191056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","chatgpt","codereview","effect-ts","github-actions","gpt","langchain","llm","openai"],"created_at":"2024-08-01T21:02:16.826Z","updated_at":"2024-11-08T16:30:36.083Z","avatar_url":"https://github.com/gvasilei.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# 🤖 Automated Code Reviews powered by ChatGPT 🤖\n\nA GitHub action uses OpenAI's GPT-4 to perform automated code reviews. When you create a PR, our action will automatically review the code and suggest changes, just like a human code reviewer would.\n\n## 🚀 How to use it\n\n- Get an API Key from [OpenAI](https://platform.openai.com/account/api-keys)\n- Add it as a GitHub secret\n- Setup an action that runs on every PR\n\n```YAML\nname: 'code-review'\non: # rebuild any PRs and main branch changes\n  pull_request:\njobs:\n  code-review:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pull-requests: write\n    steps:\n      - uses: actions/checkout@v3\n      - uses: gvasilei/AutoReviewer@0.5.1\n        env:\n          NODE_OPTIONS: '--experimental-fetch'\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          openai_api_key: ${{ secrets.OPENAI_API_KEY }}\n          exclude_files: '*.json, *.md, *.yml' # optionally exclude files based on a wildcard expression. \n```\n\n- Or when a label is added\n\n```YAML\nname: 'code-review'\non: # rebuild any PRs and main branch changes\n  pull_request:\n    types: [labeled]\njobs:\n  code-review:\n    if: ${{ contains( github.event.label.name, 'AutoReview') }}\n    runs-on: ubuntu-latest\n    permissions:\n      contents: read\n      pull-requests: write\n    steps:\n      - uses: actions/checkout@v3\n      - uses: gvasilei/AutoReviewer@0.5.1\n        env:\n          NODE_OPTIONS: '--experimental-fetch'\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          openai_api_key: ${{ secrets.OPENAI_API_KEY }}\n          exclude_files: '*.json, *.md, *.yml' # optionally exclude files based on a wildcard expression. \n```\n\n## Input parameters\n\n| **Parameter**     | **Required** | **Default**   | **Description**                                                                                                                                                                         |\n|-------------------|--------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| github_token      | True         |               | Necessary for communicating with GitHub. Autogenerated by the GHA                                                                                                                       |\n| openai_api_key    | True         |               | OpenAI API key                                                                                                                                                                          |\n| model_name        | False        | gpt-3.5-turbo | OpenAI ChatModel. Currently supports `gpt-4` and `gpt-3.5-turbo`                                                                                                                        |\n| model_temperature | False        | 0             | OpenAI model temperature                                                                                                                                                                |\n| exclude_files     | False        |               | Provide a wildcard expression to exclude files from code review.  For example, `*.md` will exclude all Markdown files. Multiple  expressions are supported via commas, eg `*.js, *.cjs` |\n\n## 🎉 Benefits\n\nUsing our GitHub action has many benefits, such as:\n\n- Faster code reviews\n- More consistent feedback\n- Increased productivity\n- Improved code quality\n\n## 🤞 Limitations\n\n- This GitHub Action is still in early development.\n- While the action supports both `gpt-4` and `gpt-3.5-turbo`, `gpt-4` gives much better suggestions.\n\n## 🙌 Contributing\n\nIf you have any ideas or improvements to our GitHub action, feel free to submit a PR. We welcome all contributions!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvasilei%2FAutoReviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgvasilei%2FAutoReviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgvasilei%2FAutoReviewer/lists"}