mirror of
https://github.com/ingress-it-solutions/gitea-code-review-action.git
synced 2025-06-28 10:34:13 +00:00
Added more descriptive summary for OpenAI
This commit is contained in:
parent
015e6a0826
commit
22776a9570
1 changed files with 36 additions and 3 deletions
39
action.yaml
39
action.yaml
|
@ -27,17 +27,50 @@ inputs:
|
||||||
default: 'github'
|
default: 'github'
|
||||||
PROMPT_TEMPLATE:
|
PROMPT_TEMPLATE:
|
||||||
description: 'The template for the FULL_REVIEW_COMMENT prompt.'
|
description: 'The template for the FULL_REVIEW_COMMENT prompt.'
|
||||||
default: 'Please analyze the pull request''s code and inform me whether it requires optimization, and provide an explanation for your decision:
|
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:
|
||||||
|
{output}
|
||||||
|
- 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:
|
||||||
|
{checklist}
|
||||||
|
|
||||||
\`\`\`
|
\`\`\`
|
||||||
${code}
|
${code}
|
||||||
\`\`\`'
|
\`\`\`'
|
||||||
|
output: '
|
||||||
|
#### 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'
|
||||||
|
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)?'
|
||||||
ANSWER_TEMPLATE:
|
ANSWER_TEMPLATE:
|
||||||
description: 'The template for the answer sent to the GitHub comment.'
|
description: 'The template for the answer sent to the GitHub comment.'
|
||||||
default: 'AI Code Review:
|
default: 'AI Code Review:
|
||||||
|
|
||||||
|
|
||||||
${answer}'
|
${answer}'
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'node16'
|
using: 'node16'
|
||||||
main: 'dist/index.js'
|
main: 'dist/index.js'
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue