Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

model parameter and makefile for compilation #16

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/code_review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_MODEL: 'gpt-3.5-turbo' ## change the model if according to your requirements
exclude: "yarn.lock,dist/**"
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.PHONY: compile

compile:
ncc build src/main.ts -o dist
ncc build src/main.ts -o dist -s
ncc build src/main.ts -o dist --license license.txt
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ jobs:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_MODEL: 'gpt-3.5-turbo' ## change the model if according to your requirements
exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas
```

Expand All @@ -62,6 +63,26 @@ the OpenAI API. It then generates review comments based on the AI's response and
Contributions are welcome! Please feel free to submit issues or pull requests to improve the AI Code Reviewer GitHub
Action.

If you make any changes to the code, please follow these steps to compile the code before submitting your changes:

1. Install the required dependencies by running the following command:
```bash
yarn install
```
2. To compile the code, use the following command:
```bash
make compile
```


3. After compiling the code, test it thoroughly to ensure everything is working as expected.

4. Submit your changes as a pull request, providing a clear description of the changes made and the problem it solves


Thank you for your contributions!


## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
3 changes: 3 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ inputs:
OPENAI_API_KEY:
description: "OpenAI API key for GPT."
required: true
OPENAI_MODEL:
description: "OpenAI model for GPT."
required: true
exclude:
description: "Glob patterns to exclude files from the diff analysis"
required: false
Expand Down
Loading