mirror of
https://github.com/freeedcom/ai-codereviewer.git
synced 2025-06-28 12:04:14 +00:00
Update README.md
Add fewer permissions to configuration, fix type in repository name, define additional steps needed for Setup guide to be working.
This commit is contained in:
parent
a9a064dfa1
commit
ce31a0d948
1 changed files with 9 additions and 5 deletions
14
README.md
14
README.md
|
@ -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
|
||||
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
|
||||
name: AI Code Reviewer
|
||||
|
@ -29,7 +31,9 @@ on:
|
|||
types:
|
||||
- opened
|
||||
- synchronize
|
||||
permissions: write-all
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
jobs:
|
||||
review:
|
||||
runs-on: ubuntu-latest
|
||||
|
@ -38,7 +42,7 @@ jobs:
|
|||
uses: actions/checkout@v3
|
||||
|
||||
- name: AI Code Reviewer
|
||||
uses: your-username/ai-code-reviewer@main
|
||||
uses: your-username/ai-codereviewer@main
|
||||
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)
|
||||
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
||||
|
@ -46,8 +50,8 @@ jobs:
|
|||
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
|
||||
located.
|
||||
4. Replace `your-username` with your GitHub username or organization name where the AI Code Reviewer repository was forked
|
||||
to.
|
||||
|
||||
5. Customize the `exclude` input if you want to ignore certain file patterns from being reviewed.
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue