mirror of
https://github.com/ingress-it-solutions/gitea-code-review-action.git
synced 2025-04-20 19:16:47 +00:00
75 lines
3.3 KiB
YAML
75 lines
3.3 KiB
YAML
name: Gitea Code Review
|
|
description: A GitHub Action that uses OpenAI to review code in pull request.
|
|
inputs:
|
|
PROGRAMMING_LANGUAGE:
|
|
description: 'The programming language used in the GitHub repository. If not provided, the detected programming language will be used.'
|
|
default: ''
|
|
FULL_REVIEW_COMMENT:
|
|
description: 'The comment to trigger a code review for the pull request.'
|
|
default: 'openai'
|
|
REVIEW_COMMENT_PREFIX:
|
|
description: 'The comment prefix to trigger a code review with the comment content.'
|
|
default: 'openai:'
|
|
OPENAI_TOKEN:
|
|
description: 'The API token for the OpenAI API.'
|
|
required: true
|
|
GITHUB_TOKEN:
|
|
description: 'The API token for the Github API.'
|
|
required: true
|
|
GITHUB_BASE_URL:
|
|
description: 'The base URL for the GitHub API.'
|
|
MAX_CODE_LENGTH:
|
|
description: 'The maximum code length for the pull request to be sent to OpenAI.'
|
|
default: 6000
|
|
type: int
|
|
SOURCE_AT:
|
|
description: 'Where is the source code located'
|
|
default: 'github'
|
|
PROMPT_TEMPLATE:
|
|
description: 'The template for the FULL_REVIEW_COMMENT prompt.'
|
|
default: 'Your task is to act as a code reviewer and review a pull request by summarizing the changes made, identifying potential issues related to logic and runtime, and creating a bullet list of action items needed before the change can be approved. The output should focus on items mentioned in the given code review checklist.
|
|
Instructions:
|
|
- Review the output of git diff for the pull request
|
|
- Summarize the overview of the changes made
|
|
- Identify potential issues related to logic and runtime
|
|
- Output as a markdown document, with the following sections:
|
|
#### Overview of changes:
|
|
- Summarize the overview of the changes made
|
|
#### issues:
|
|
- Identify potential issues related to logic and runtime
|
|
- Identify issues mentioned in the code review checklist
|
|
#### Action items:
|
|
- Action items needed before the change can be approved
|
|
- If there are no issues, output "None"
|
|
- If there are no action items, output "None"
|
|
- Create a bullet list of action items needed before the change can be approved
|
|
- The response sentences are no longer than 16 words each
|
|
- Keep the response sentences as short as possible
|
|
- Focus on items mentioned in the given code review checklist:
|
|
Code Structure
|
|
- Is the codebase organized according to Laravel Framework recommended project structure?
|
|
- Are there any unnecessary files, folders, or code modules?
|
|
- Does the code follow the Single Responsibility Principle (SRP) and Dont Repeat Yourself (DRY) principle?
|
|
Error Handling
|
|
- Are all error scenarios covered in the code?
|
|
- Are the error messages clear and helpful?
|
|
- Is the code handling errors gracefully?
|
|
Security
|
|
- Are sensitive data and credentials stored securely?
|
|
- Are all external libraries and packages up-to-date?
|
|
- Is the code protected against common security vulnerabilities such as SQL injection and cross-site scripting (XSS)?
|
|
|
|
\`\`\`
|
|
${code}
|
|
\`\`\`'
|
|
|
|
ANSWER_TEMPLATE:
|
|
description: 'The template for the answer sent to the GitHub comment.'
|
|
default: 'AI Code Review:
|
|
=======
|
|
### Summary:
|
|
|
|
${answer}'
|
|
runs:
|
|
using: 'node16'
|
|
main: 'dist/index.js'
|