Skip to content

Commit 6a8ef67

Browse files
update docs with PR Stage and others (#336)
1 parent 41703ce commit 6a8ef67

File tree

1 file changed

+33
-23
lines changed

1 file changed

+33
-23
lines changed

docs/guides/custom-reports.md

+33-23
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ Contained within the `<pr_details>` tag.
7676
- `State`: string ("open"/"closed") - Current state of the PR
7777
- `Mergeable`: boolean (true/false) - Whether the PR can be merged
7878
- `Is stale`: boolean - Whether PR has been inactive for over 168 hours
79+
- `PR Stage`: string - The current stage of open PRs in Open or Draft state, can be one of:
80+
- "Needs Author Action" - PR requires author attention due to merge conflicts, draft status, or requested changes
81+
- "Waiting for Author to Merge" - PR has approvals and is ready for author to merge
82+
- "Waiting for Code Reviews" - PR is waiting for reviewers to approve
83+
- undefined - PR is not in an open state (is merged or closed)
7984

8085
#### Basic Information
8186

@@ -124,60 +129,65 @@ Generate a summary of each pull request in the following bullet point format:
124129
- If 'Merged: true' set 'PR State: 🔀 Merged'
125130
- Else If 'Draft: true' set 'PR State: 📝 Draft'
126131
- Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
127-
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
132+
- Else If 'State: closed' or 'State: DECLINED' and 'Merged: false' set 'PR State: 🔒 Closed'
128133
- Else set 'PR State: ❓ Unknown'
129134
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
130-
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
135+
- Mergeable (if PR State is not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable' based on the "Mergeable: " value.
136+
- PR Stage (if PR State is not 'Merged'): Provide the stage of the PR based on the "PR Stage: " value.
131137
- Summary: In under 50 words provide a short summary of the PR.
132138
- Comments: In under 50 words provide a short summary of all comments found within <pr_comments>, including each comments author username from <comment_author_username>. If there are no comments available, output 'No comments'.
133139
</overall_instructions>
134140
135141
<example>
136142
- **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
137-
- **Title:** [PR Title]
143+
- **Title:** PR Title
138144
- **PR State:** 💬 Open
139145
- **Mergeable:** Mergeable
140-
- **Summary:** [Summary of the PR].
141-
- **Comments:** [Summary of the PR comments].
146+
- **PR Stage:** Waiting for Code Reviews
147+
- **Summary:** Summary of the PR.
148+
**Comments:** Summary of PR comments or No comments.
142149
143150
- **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
144-
- **Title:** [PR Title]
151+
- **Title:** PR Title
145152
- **PR State:** 💬 Open
146153
- **Mergeable:** Mergeable
147-
- **Summary:** [Summary of the PR].
148-
- **Comments:** [Summary of the PR comments].
154+
- **PR Stage:** Waiting for Author to Merge
155+
- **Summary:** Summary of the PR.
156+
- **Comments:** Summary of the PR comments or No comments.
149157
150158
- **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
151-
- **Title:** [PR Title]
159+
- **Title:** PR Title
152160
- **PR State:** 🔀 Merged
153-
- **Summary:** [Summary of the PR].
154-
- **Comments:** [Summary of the PR comments].
161+
- **Summary:** Summary of the PR.
162+
- **Comments:** Summary of the PR comments or No comments.
155163
156164
- **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14)
157-
- **Title:** [PR Title]
165+
- **Title:** PR Title
158166
- **PR State:** 💬 Open
167+
- **PR Stage:** Needs Author Action
159168
- **Mergeable:** Mergeable
160-
- **Summary:** [Summary of the PR].
161-
- **Comments:** [Summary of the PR comments].
169+
- **Summary:** Summary of the PR.
170+
- **Comments:** Summary of the PR comments or No comments.
162171
163172
- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
164-
- **Title:** [PR Title]
173+
- **Title:** PR Title
165174
- **PR State:** 🔀 Merged
166-
- **Summary:** [Summary of the PR].
167-
- **Comments:** [Summary of the PR comments].
175+
- **Summary:** Summary of the PR.
176+
- **Comments:** Summary of the PR comments or No comments.
168177
169178
- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
170-
- **Title:** [PR Title]
179+
- **Title:** PR Title
171180
- **PR State:** 🔀 Merged
172-
- **Summary:** [Summary of the PR].
173-
- **Comments:** [Summary of the PR comments].
181+
- **Summary:** Summary of the PR.
182+
- **Comments:** Summary of the PR comments or No comments.
174183
175184
- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
176-
- **Title:** [PR Title]
185+
- **Title:** PR Title
177186
- **PR State:** 📝 Draft
178187
- **Mergeable:** Not Mergeable
179-
- **Summary:** [Summary of the PR].
180-
- **Comments:** [Summary of the PR comments].
188+
**PR Stage:** Needs Author Action
189+
190+
**Comments:** Summary of PR comments or No comments.
181191
</example>
182192
```
183193

0 commit comments

Comments
 (0)