Skip to content

update docs with PR Stage and others #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 13, 2025
Merged

update docs with PR Stage and others #336

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d04ef1
update docs with PR Stage and others
alexcoderabbitai May 13, 2025
d576a39
cleanup example
alexcoderabbitai May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 33 additions & 23 deletions docs/guides/custom-reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ Contained within the `<pr_details>` tag.
- `State`: string ("open"/"closed") - Current state of the PR
- `Mergeable`: boolean (true/false) - Whether the PR can be merged
- `Is stale`: boolean - Whether PR has been inactive for over 168 hours
- `PR Stage`: string - The current stage of open PRs in Open or Draft state, can be one of:
- "Needs Author Action" - PR requires author attention due to merge conflicts, draft status, or requested changes
- "Waiting for Author to Merge" - PR has approvals and is ready for author to merge
- "Waiting for Code Reviews" - PR is waiting for reviewers to approve
- undefined - PR is not in an open state (is merged or closed)

#### Basic Information

Expand Down Expand Up @@ -124,60 +129,65 @@ Generate a summary of each pull request in the following bullet point format:
- If 'Merged: true' set 'PR State: 🔀 Merged'
- Else If 'Draft: true' set 'PR State: 📝 Draft'
- Else If 'State: open' or 'State: active' set 'PR State: 💬 Open'
- Else If 'State: closed' and 'Merged: false' set 'PR State: 🔒 Closed'
- Else If 'State: closed' or 'State: DECLINED' and 'Merged: false' set 'PR State: 🔒 Closed'
- Else set 'PR State: ❓ Unknown'
- If the PR is stale, add '⚠️ Stale' at the end of the PR State.
- Mergeable (if PR State if not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable'.
- Mergeable (if PR State is not 'Merged'): Provide the mergeable status of the PR as 'Mergeable' or 'Not Mergeable' based on the "Mergeable: " value.
- PR Stage (if PR State is not 'Merged'): Provide the stage of the PR based on the "PR Stage: " value.
- Summary: In under 50 words provide a short summary of the PR.
- 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'.
</overall_instructions>

<example>
- **PR Link:** [#3001](https://github.com/mygithuborg/myrepo/pull/3001)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 💬 Open
- **Mergeable:** Mergeable
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **PR Stage:** Waiting for Code Reviews
- **Summary:** Summary of the PR.
**Comments:** Summary of PR comments or No comments.

- **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 💬 Open
- **Mergeable:** Mergeable
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **PR Stage:** Waiting for Author to Merge
- **Summary:** Summary of the PR.
- **Comments:** Summary of the PR comments or No comments.

- **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 🔀 Merged
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **Summary:** Summary of the PR.
- **Comments:** Summary of the PR comments or No comments.

- **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 💬 Open
- **PR Stage:** Needs Author Action
- **Mergeable:** Mergeable
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **Summary:** Summary of the PR.
- **Comments:** Summary of the PR comments or No comments.

- **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 🔀 Merged
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **Summary:** Summary of the PR.
- **Comments:** Summary of the PR comments or No comments.

- **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 🔀 Merged
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
- **Summary:** Summary of the PR.
- **Comments:** Summary of the PR comments or No comments.

- **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007)
- **Title:** [PR Title]
- **Title:** PR Title
- **PR State:** 📝 Draft
- **Mergeable:** Not Mergeable
- **Summary:** [Summary of the PR].
- **Comments:** [Summary of the PR comments].
**PR Stage:** Needs Author Action

**Comments:** Summary of PR comments or No comments.
</example>
```

Expand Down