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

Merge ce31a0d948 into a9a064dfa1

Browse source
This commit is contained in:
Nikita Bishonen 2024-03-15 20:45:31 +04:00 • committed by GitHub
commit 6115ae26d6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -19,7 +19,9 @@ review process.
2. Add the OpenAI API key as a GitHub Secret in your repository with the name `OPENAI_API_KEY`. You can find more 2. Add the OpenAI API key as a GitHub Secret in your repository with the name `OPENAI_API_KEY`. You can find more
information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets). information about GitHub Secrets [here](https://docs.github.com/en/actions/reference/encrypted-secrets).
3. Create a `.github/workflows/main.yml` file in your repository and add the following content: 3. Fork this repository to your personal space or organization.
4. Create a `.github/workflows/main.yml` file in your repository and add the following content:
```yaml ```yaml
name: AI Code Reviewer name: AI Code Reviewer
@ -29,7 +31,9 @@ on:
types: types:
- opened - opened
- synchronize - synchronize
permissions: write-all permissions:
contents: read
pull-requests: write
jobs: jobs:
review: review:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -38,7 +42,7 @@ jobs:
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: AI Code Reviewer - name: AI Code Reviewer
uses: your-username/ai-code-reviewer@main uses: your-username/ai-codereviewer@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,8 +50,8 @@ 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. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository was forked
located. to.
5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed. 5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.