From 6d04ef15f35c203f9bcd62deca99291f97ea088b Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 13 May 2025 14:32:33 -0400 Subject: [PATCH 1/4] update docs with PR Stage and others --- docs/guides/custom-reports.md | 56 +++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index c006207a..087f34eb 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -76,6 +76,11 @@ Contained within the `` 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 @@ -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 , including each comments author username from . If there are no comments available, output 'No comments'. - **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 the 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" +- **Summary:** Summary of the PR. +- **Comments:** Summary of the PR comments or No Comments. ``` From d576a39e2bd3602130278660e9f66bce8c35bc87 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 13 May 2025 15:03:36 -0400 Subject: [PATCH 2/4] cleanup example --- docs/guides/custom-reports.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 087f34eb..7ed5a08e 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -145,7 +145,7 @@ Generate a summary of each pull request in the following bullet point format: - **Mergeable:** Mergeable - **PR Stage:** Waiting for Code Reviews - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. + **Comments:** Summary of PR comments or No comments. - **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302) - **Title:** PR Title @@ -153,41 +153,41 @@ Generate a summary of each pull request in the following bullet point format: - **Mergeable:** Mergeable - **PR Stage:** Waiting for Author to Merge - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3](https://github.com/mygithuborg/myotherrepo/pull/3) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14) - **Title:** PR Title - **PR State:** 💬 Open -- **PR Stage:** "Needs Author Action" +- **PR Stage:** Needs Author Action - **Mergeable:** Mergeable - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#13005](https://github.com/mygithuborg/backend/pull/13005) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3006](https://github.com/mygithuborg/myrepo/pull/3006) - **Title:** PR Title - **PR State:** 🔀 Merged - **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#3007](https://github.com/mygithuborg/myrepo/pull/3007) - **Title:** PR Title - **PR State:** 📝 Draft - **Mergeable:** Not Mergeable -- **PR Stage:** "Needs Author Action" -- **Summary:** Summary of the PR. -- **Comments:** Summary of the PR comments or No Comments. + **PR Stage:** Needs Author Action + + **Comments:** Summary of PR comments or No comments. ``` From 7db1abe97945188782523f42b6c3bdcfe9c47e78 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 13 May 2025 15:12:58 -0400 Subject: [PATCH 3/4] fix cursor mistakes --- docs/guides/custom-reports.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 7ed5a08e..81c9dfb3 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -145,7 +145,7 @@ Generate a summary of each pull request in the following bullet point format: - **Mergeable:** Mergeable - **PR Stage:** Waiting for Code Reviews - **Summary:** Summary of the PR. - **Comments:** Summary of PR comments or No comments. +- **Comments:** Summary of the PR comments or No comments. - **PR Link:** [#302](https://github.com/mygithuborg/thatrepo/pull/302) - **Title:** PR Title @@ -185,9 +185,9 @@ Generate a summary of each pull request in the following bullet point format: - **Title:** PR Title - **PR State:** 📝 Draft - **Mergeable:** Not Mergeable - **PR Stage:** Needs Author Action - - **Comments:** Summary of PR comments or No comments. +- **PR Stage:** Needs Author Action +- **Summary:** Summary of the PR. +- **Comments:** Summary of the PR comments or No comments. ``` From 8c0a2f9b88037961f4ddfcdf004137d78067ab02 Mon Sep 17 00:00:00 2001 From: alex Date: Tue, 13 May 2025 15:16:54 -0400 Subject: [PATCH 4/4] fix order --- docs/guides/custom-reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 81c9dfb3..dbc04280 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -164,8 +164,8 @@ Generate a summary of each pull request in the following bullet point format: - **PR Link:** [#14](https://github.com/mygithuborg/frontend/pull/14) - **Title:** PR Title - **PR State:** 💬 Open -- **PR Stage:** Needs Author Action - **Mergeable:** Mergeable +- **PR Stage:** Needs Author Action - **Summary:** Summary of the PR. - **Comments:** Summary of the PR comments or No comments. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy