Update README.md for ease of use #36
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update description to make the action easier to use and avoid confusion
Correct readme to communicate that forking the repository is required for the workflow to work
villesau
reviewed
Jan 13, 2024
| @@ -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 account or organization | |||
There was a problem hiding this comment.
Forking is not needed, this action is available in the marketplace too: https://github.com/marketplace/actions/ai-code-review-action
villesau
reviewed
Jan 13, 2024
| @@ -38,20 +40,19 @@ jobs: | |||
| uses: actions/checkout@v3 | |||
|
|
|||
| - name: AI Code Reviewer | |||
| uses: your-username/ai-code-reviewer@main | |||
| uses: your-username/ai-codereviewer@main | |||
There was a problem hiding this comment.
This works too: freeedcom/ai-codereviewer@v2.7.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update description to make the action easier to use and avoid confusion