1
- name : " OpenAI-based PR Reviewer & Summarizer"
2
- description : " OpenAI-based PR Reviewer and Summarizer"
1
+ name : ' OpenAI-based PR Reviewer & Summarizer'
2
+ description : ' OpenAI-based PR Reviewer and Summarizer'
3
3
branding :
4
- icon : " aperture"
5
- color : " orange"
6
- author : " FluxNinja, Inc."
4
+ icon : ' aperture'
5
+ color : ' orange'
6
+ author : ' FluxNinja, Inc.'
7
7
inputs :
8
8
debug :
9
9
required : false
10
- description : " Enable debug mode"
11
- default : " false"
10
+ description : ' Enable debug mode'
11
+ default : ' false'
12
12
temperature :
13
13
required : false
14
- description : " Temperature for GPT model"
15
- default : " 0.0"
14
+ description : ' Temperature for GPT model'
15
+ default : ' 0.0'
16
16
review_comment_lgtm :
17
17
required : false
18
- description : " Leave comments even if the patch is LGTM"
19
- default : " false"
18
+ description : ' Leave comments even if the patch is LGTM'
19
+ default : ' false'
20
20
path_filters :
21
21
required : false
22
22
description : |
@@ -44,7 +44,7 @@ inputs:
44
44
!**/vendor/**
45
45
system_message :
46
46
required : false
47
- description : " System message to be sent to OpenAI"
47
+ description : ' System message to be sent to OpenAI'
48
48
default : |
49
49
You are a very experienced software engineer. You are able to thoroughly review code changes and uncover
50
50
issues (if there are any) such as logic errors, syntax errors, out of bound errors, potential data races,
@@ -53,7 +53,7 @@ inputs:
53
53
We will be doing code reviews today.
54
54
summarize_beginning :
55
55
required : false
56
- description : " The prompt for the whole pull request"
56
+ description : ' The prompt for the whole pull request'
57
57
default : |
58
58
$system_message
59
59
@@ -64,7 +64,9 @@ inputs:
64
64
65
65
I have a pull request with title "$title" and the description is as follows,
66
66
67
- > $description.
67
+ ```
68
+ $description
69
+ ```
68
70
69
71
Next, I will be providing you diffs for each file for you to summarize. In every response,
70
72
you will update the high-level summary of the entire pull request, the table for each file's
@@ -74,11 +76,17 @@ inputs:
74
76
Reply "OK" to confirm that you are ready to receive the diffs for summarization.
75
77
summarize_file_diff :
76
78
required : false
77
- description : " The prompt for each file diff"
79
+ description : ' The prompt for each file diff'
78
80
default : |
79
- Providing diff for `$filename`.
81
+ Summary generated by you for other files, is as follows and you can use
82
+ this summary as a basis for your response.
80
83
81
- I would like you to summarize the diff and add the summary for this file in the table.
84
+ ```
85
+ $summary
86
+ ```
87
+
88
+ I am providing diff for `$filename` below. I would like you to summarize the diff and add the summary
89
+ for this file in the table.
82
90
83
91
In response, please provide the updated high-level summary, the summary table of the files
84
92
we have summarized so far and your overall feedback to the developer.
@@ -88,9 +96,16 @@ inputs:
88
96
```
89
97
summarize :
90
98
required : false
91
- description : " The prompt for final summarization response"
99
+ description : ' The prompt for final summarization response'
92
100
default : |
93
- This is the end of summarization session. Please provide the final response as follows in
101
+ This is the end of summarization session. Below is the summary you have generated so far in our previous
102
+ conversations. Please use this as a basis for your final response.
103
+
104
+ ```
105
+ $summary
106
+ ```
107
+
108
+ Please provide the final response as follows in
94
109
the `markdown` format with the following content:
95
110
- Thank the user for letting you participate in the code review.
96
111
- High-level summary (focus on the purpose and intent within 80 words)
@@ -101,7 +116,7 @@ inputs:
101
116
request.
102
117
summarize_release_notes :
103
118
required : false
104
- description : " The prompt for generating release notes"
119
+ description : ' The prompt for generating release notes'
105
120
default : |
106
121
Next, release notes in `markdown` format for this pull request that focuses on the purpose
107
122
of this PR. If needed, you can classify the changes as "New Feature", "Bug fix",
@@ -111,7 +126,7 @@ inputs:
111
126
used as is in our release notes.
112
127
review_beginning :
113
128
required : false
114
- description : " The beginning prompt of a code review dialog"
129
+ description : ' The beginning prompt of a code review dialog'
115
130
default : |
116
131
$system_message
117
132
@@ -121,16 +136,20 @@ inputs:
121
136
122
137
I have a pull request with title "$title" and the description is as follows,
123
138
124
- > $description.
139
+ ```
140
+ $description
141
+ ```
125
142
126
143
OpenAI generated summary is as follows,
127
144
128
- > $summary
145
+ ```
146
+ $summary
147
+ ```
129
148
130
149
Reply "OK" to confirm that you are ready for further instructions.
131
150
review_file :
132
151
required : false
133
- description : " The prompt for each file"
152
+ description : ' The prompt for each file'
134
153
default : |
135
154
Providing `$filename` content as context. Please use this context when reviewing patches.
136
155
@@ -139,7 +158,7 @@ inputs:
139
158
```
140
159
review_file_diff :
141
160
required : false
142
- description : " The prompt for each file diff"
161
+ description : ' The prompt for each file diff'
143
162
default : |
144
163
Providing entire diff for `$filename` as context. Please use this context when reviewing patches.
145
164
@@ -148,7 +167,7 @@ inputs:
148
167
```
149
168
review_patch_begin :
150
169
required : false
151
- description : " The prompt for each file diff"
170
+ description : ' The prompt for each file diff'
152
171
default : |
153
172
Next, I will send you a series of patches, each of them consists of a diff snippet, and you
154
173
need to do a brief code review for every patch, and tell me any bug risk or improvement
@@ -159,13 +178,13 @@ inputs:
159
178
preferred for your responses. Reply "OK" to confirm.
160
179
review_patch :
161
180
required : false
162
- description : " The prompt for each chunks/patches"
181
+ description : ' The prompt for each chunks/patches'
163
182
default : |
164
183
$filename
165
184
166
185
```diff
167
186
$patch
168
187
```
169
188
runs :
170
- using : " node16"
171
- main : " dist/index.js"
189
+ using : ' node16'
190
+ main : ' dist/index.js'
0 commit comments