gh pr checks #1563

vilmibm · 2020-08-21T17:12:31Z

This PR adds a basic first version of gh pr checks. It accepts no flags and its only positional argument is a PR selector; otherwise, the current PR is used.

Considerations:

~~the unicode bullet originally used in the mockups caused formatting glitches; it was not printed as a full width character. I wasn't able to find a suitable replacement and used . for now.~~ switched to - as per ampinsk's suggestion
I added the detail of the check URL; this makes it very quick to debug a failing check but might be too much visual clutter
A common usecase is likely going to be watching these checks. Right now running this command with watch (watch gh pr checks) means that the output is formatted for machines and not people. I'd like a workaround for this; either a --watch parameter we provide ourselves, a --color parameter that overrides the tty detection, or something else.

TTY output

non TTY output

Ref. #1525

ampinsk · 2020-08-25T17:24:56Z

the unicode bullet originally used in the mockups caused formatting glitches; it was not printed as a full width character. I wasn't able to find a suitable replacement and used . for now.

Let's use - for this!

mislav

This looks good! I have some questions for whether they were planned to be rolled up in the same PR:

In pr status, we display the summary of both Checks and Statuses, since the PR Merge Box in the web interface displays the summary of both. This change set only seems to aggregate Checks; was support for Statuses planned as part of the same iteration?
Should we attempt to order the list of Checks the same way the web interface does? I'm guessing the rough algorithm is: first failing, then pending, and alphabetical order for anything in-between.
When a repository (like ours) has both push and pull_request actions, each resulting run is rendered twice. For example, I see build (ubuntu-latest) reported twice, but there is no indicator which one is push and which one is pull_request like in the web interface. Do we have enough information from the API to disambiguate this?

Ref. #1529

pkg/cmd/pr/checks/http.go

vilmibm · 2020-08-26T22:31:56Z

wow TIL that statuses and checks are two different things. That clarifies some things. 🤦 🤦 🤦 🤦 🤦

I'll work on including those, changing the ordering, and exposing the push/pullrequest thing (if it's possible thru the api)

A basic first pass on gh pr checks that shows all check runs for a given PR's latest commit.

vilmibm · 2020-08-28T18:20:21Z

okay, this is ready for re-review @mislav .

I:

sort by status then lexicographically (failed, pending, success)
included statuses by switching to the rollup API
determined that there wasn't a way to pull the push vs. pull_request event type out of the API

mislav

Awesome work; thank you! A few notes, but all things that can potentially be addressed as follow-up, so nothing blocking. 🚀

pkg/cmd/pr/checks/checks.go

api/queries_pr.go

mislav · 2020-09-02T12:14:41Z

api/queries_pr.go

+					nodes {
+						commit {
+              oid
+						  statusCheckRollup {


My slight concern with expanding the PullRequestByNumber is that the Checks+Statuses data is unnecessarily fetched every time a user does any operation on a pull request, such as gh pr view 123 --web. However, I do understand that this approach is the most feasible to implement, since any other course of action would require us to either duplicate the logic of shared.PRFromArgs() to fetch extra fields, or to come up with a shippable solution to #1081. I'm only bringing this up as a note that this is a good candidate to revisit in a few weeks 👍

pkg/cmd/pr/checks/checks.go

mislav · 2020-09-02T12:28:59Z

pkg/cmd/pr/checks/checks.go

+			tp.AddField(o.mark, nil, nil)
+			tp.AddField(o.name, nil, nil)
+			tp.AddField(o.elapsed, nil, nil)
+			tp.AddField(o.link, nil, nil)


This one is tricky! We render the URL in this column, but the way I designed TablePrinter is to automatically truncate long columns in narrow terminals. That means that the URL column will be the first one put up on the chopping block, and URLs become completely useless after they are truncated.

A good followup candidate would be to add a feature to TablePrinter to mark some columns as exempt from elastic resizing/truncation.

pkg/cmd/pr/checks/checks.go

vilmibm · 2020-09-02T16:34:08Z

this is merge-able but going to wait to merge since there is already a ton going into the next release.

tierninho · 2020-09-02T19:21:45Z

It accepts no flags

gh pr checks -R tierninho/blah
argument required when using the --repo flag

Was the -R flag supposed to be excluded as well as the error message might confuse the user.

vilmibm · 2020-09-02T20:11:22Z

@tierninho you found a bug D: I'll fix that; -R should work here.

mislav · 2020-09-03T10:03:40Z

@vilmibm I'm thinking that the current -R error is in order: #1585

vilmibm · 2020-09-03T14:01:53Z

ahhh right, thanks for the reminder.

vilmibm · 2020-09-03T19:52:48Z

@tierninho I merged in trunk to get the fix for that -R problem.

tierninho · 2020-09-04T01:00:47Z

If checks are at a repo level, should we prevent this cmd as it implies branches can be queried?

gh pr checks sdsdf
no open pull requests found for branch "sdsdf"

vilmibm · 2020-09-04T03:23:31Z

it's at the pr level. the R flag is for looking up a PR via argument in another repo.

vilmibm force-pushed the checks branch from a0abd7a to 72072f6 Compare August 25, 2020 16:28

vilmibm marked this pull request as ready for review August 25, 2020 16:33

vilmibm requested review from ampinsk and mislav August 25, 2020 16:40

vilmibm changed the title ~~WIP pr checks~~ gh pr checks Aug 25, 2020

mislav reviewed Aug 26, 2020

View reviewed changes

pkg/cmd/pr/checks/http.go Outdated Show resolved Hide resolved

pkg/cmd/pr/checks/http.go Outdated Show resolved Hide resolved

vilmibm force-pushed the checks branch from d4dbf63 to 058cd6c Compare August 27, 2020 22:20

gh pr checks

8dd93e1

A basic first pass on gh pr checks that shows all check runs for a given PR's latest commit.

vilmibm force-pushed the checks branch from 4e9caa7 to 8dd93e1 Compare August 28, 2020 18:19

mislav approved these changes Sep 2, 2020

View reviewed changes

mislav reviewed Sep 2, 2020

View reviewed changes

pkg/cmd/pr/checks/checks.go Outdated Show resolved Hide resolved

review feedback

2961c65

Merge remote-tracking branch 'origin/trunk' into checks

eb132a1

mislav mentioned this pull request Sep 7, 2020

Add command to watch running Github Action(s) in repo #1634

Closed

vilmibm merged commit ab2c38e into trunk Sep 8, 2020

mislav deleted the checks branch September 9, 2020 12:33

gh pr checks #1563

gh pr checks #1563

Uh oh!

Conversation

vilmibm commented Aug 21, 2020 • edited by mislav Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TTY output

non TTY output

Uh oh!

ampinsk commented Aug 25, 2020

Uh oh!

mislav left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vilmibm commented Aug 26, 2020

Uh oh!

vilmibm commented Aug 28, 2020

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mislav Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mislav Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vilmibm commented Sep 2, 2020

Uh oh!

tierninho commented Sep 2, 2020

Uh oh!

vilmibm commented Sep 2, 2020

Uh oh!

mislav commented Sep 3, 2020

Uh oh!

vilmibm commented Sep 3, 2020

Uh oh!

vilmibm commented Sep 3, 2020

Uh oh!

tierninho commented Sep 4, 2020

Uh oh!

vilmibm commented Sep 4, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vilmibm commented Aug 21, 2020 •

edited by mislav

Loading

mislav left a comment •

edited

Loading