Repository navigation
Mention pr checks in pr status docs #1807
Description
This issue covers adding hints to the usage information for pr status about pr checks. This requires adding a Long section to the cobra.Command{} invocation (or perhaps Examples).
Original body:
Describe the feature or problem you’d like to solve
When listing all PRs relevant to me (e.g. gh pr status), I'd like a flag to see a long version of the check results instead running gh pr checks <PR number> for each PR.
Proposed solution
Add a flag, to be used by gh pr status and/or gh pr list.
Perhaps another option to hide the extra details on the passing ones, if one doesn't care for it.
# Viewing the status of your relevant pull requests
~/Projects/my-project$ gh pr status --long
Current branch
#12 Remove the test feature [user:patch-2]
- All checks failing - Review required
- X Check 1
- X Check 2 https://link.to.check.results.com/12
Created by you
You have no open pull requests
Requesting a code review from you
#13 Fix tests [branch]
- 3/4 checks failing - Review required
- X Check 1
- ✓ Check 2 https://link.to.check.results.com/13
#15 New feature [branch]
- Checks passing - Approved
~/Projects/my-project$
Activity
vilmibm commentedon Sep 18, 2020
I'm intrigued by this idea; a
--verbosemight work or a more specific--checks. what do you think, @ampinsk ?cole-gillespie commentedon Sep 19, 2020
+1 for
-v, --verbosejust because that is my first go to when trying to get more info. i think the output of verbose should be more verbose than justchecks. when i list prs in verbose mode I want to not only see thechecksbut alsoviewthe pr. So maybe the right thing to do here is add a verbose flag onlistthat lets there be all of the data known when running--verbosebut also add other flags like--checksand--viewthat will allow the user to choose what they display.ampinsk commentedon Sep 24, 2020
@beepbopboobop thanks for this suggestion! Is there a reason you'd want the verbose output on
gh pr statusinstead ofgh pr checks?StephenGregory commentedon Sep 24, 2020
@ampinsk Perhaps you meant to tag me?
Obvious subjective, but having the verbose output on
gh pr statusseemed like more appropriate command to display all the info of PRs relevant to me:Since it already had a checks summary, I felt it'd be a good fit.
Meanwhile,
gh pr checkswould just tell you check status, but I want a bit more than that.rainersigwald commentedon Dec 21, 2020
@ampinsk my 2¢: I expected a UX more similar to the PR page on github.com: tell me overall check status and approval status; have some sort of toggle for details of both.
I came here because I was searching for a way to get detailed check status in
gh pr status-- it didn't occur to me to trygh pr checks. I first rangh pr statusand saw theChecks pendingand wanted to know "which ones?". After seeing #1807 (comment) I ranchecksand it's exactly what I wanted, but it wasn't obvious to me.vilmibm commentedon Mar 9, 2022
gh pr statusalready has the potential to produce very long output and after discussing this we've decided not to add this.however, there is still useful work that can be done for this issue: adding mention of
gh pr checksto the usage doc forgh pr status.I'm going to edit the title/body of the issue to reflect that.
[-]Display individual checks of all relevant PRs[/-][+]Mention pr checks in pr status docs[/+]