actions/ai-codereviewer
2
0
Fork 0
mirror of https://github.com/freeedcom/ai-codereviewer.git synced 2025-04-21 10:06:47 +00:00
Code Issues Projects Releases Packages Wiki Activity

updating the docs and yaml

Browse source
This commit is contained in:
Michael Pond 2024-08-15 09:51:46 -04:00
parent 34ab214246
commit b6f05d7200
3 changed files with 12 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/code_review.yml vendored
View file

@ -1,4 +1,4 @@
name: Code Review with OpenAI name: CDS Code Review with OpenAI
on: on:
pull_request: pull_request:
types: types:
@ -12,7 +12,7 @@ jobs:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Code Review - name: Code Review
uses: freeedcom/ai-codereviewer@main uses: cds-snc/cds-ai-codereviewer@main
with: with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

21
README.md
View file

@ -1,6 +1,6 @@
# AI Code Reviewer # CDS AI Code Reviewer
AI Code Reviewer is a GitHub Action that leverages OpenAI's GPT-4 API to provide intelligent feedback and suggestions on CDS AI Code Reviewer is a GitHub Action that leverages OpenAI's GPT-4 API to provide intelligent feedback and suggestions on
your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code your pull requests. This powerful tool helps improve code quality and saves developers time by automating the code
review process. review process.
@ -22,7 +22,7 @@ review process.
3. Create a `.github/workflows/main.yml` file in your repository and add the following content: 3. Create a `.github/workflows/main.yml` file in your repository and add the following content:
```yaml ```yaml
name: AI Code Reviewer name: CDS AI Code Reviewer
on: on:
pull_request: pull_request:
@ -37,8 +37,8 @@ jobs:
- name: Checkout Repo - name: Checkout Repo
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: AI Code Reviewer - name: CDS AI Code Reviewer
uses: your-username/ai-code-reviewer@main uses: cds-snc/cds-ai-code-reviewer@main
with: with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
@ -46,21 +46,18 @@ jobs:
exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas exclude: "**/*.json, **/*.md" # Optional: exclude patterns separated by commas
``` ```
4. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository is 4. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.
located.
5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed. 5. Commit the changes to your repository, and CDS AI Code Reviewer will start working on your future pull requests.
6. Commit the changes to your repository, and AI Code Reviewer will start working on your future pull requests.
## How It Works ## How It Works
The AI Code Reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to The CDS AI Code Reviewer GitHub Action retrieves the pull request diff, filters out excluded files, and sends code chunks to
the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request. the OpenAI API. It then generates review comments based on the AI's response and adds them to the pull request.
## Contributing ## Contributing
Contributions are welcome! Please feel free to submit issues or pull requests to improve the AI Code Reviewer GitHub Contributions are welcome! Please feel free to submit issues or pull requests to improve the CDS AI Code Reviewer GitHub
Action. Action.
Let the maintainer generate the final package (`yarn build` & `yarn package`). Let the maintainer generate the final package (`yarn build` & `yarn package`).

2
action.yml
View file

@ -1,4 +1,4 @@
name: "AI Code Review Action" name: "CDS AI Code Review Action"
description: "Perform code reviews and comment on diffs using OpenAI API." description: "Perform code reviews and comment on diffs using OpenAI API."
inputs: inputs:
GITHUB_TOKEN: GITHUB_TOKEN: