gh run watch --for <ref>

[nyarly]

Describe the feature or problem you’d like to solve

Related to #5493 and #3559 - when using the gh workflow and gh run subcommands, I'm usually trying to develop and debug a workflow. Being able to immediately watch the results of triggering a workflow, of rerunning a failed workflow run and the workflow run that results from a git push would all be incredibly useful.

Proposed solution

A flag for gh run watch that looks up the current running workflow run for a git ref would solve all three use cases. Alternatively, a utility command to look up the run id would be fine, since you could gh run watch $(gh run current-for <ref>) or something.

How will it benefit CLI and its users?

Having an end-to-end solution for "initiate a run, wait until done, review logs" that doesn't entail operator intervention two or three times has got to be a benefit.

[samcoe]

@nyarly Seems like we mostly already support this:

gh run watch $(gh run list --branch trunk --limit 1 --json databaseId --jq '.[].databaseId')

Unfortunately the list workflow runs endpoint only supports listing by branch instead of ref so I am not sure there is much else we can do here.

[nyarly]

I mean, I've wound up writing a script like gh api "/repos/ymeadows/tier0-cluster/actions/runs?status=in_progress" -q '. | select(.total_count == 1) | .workflow_runs[0].id' to kind of emulate this behavior. I think the runs also have a head_id field that could limit it to the current ref as well.

I guess I'm dismayed by what seems like a common use case ("watch the run I just triggered") having such a kludgy interface

[mislav]

@nyarly Agreed that it's kludgy. The problem is that at the time of dispatching the workflow, we don't know any ID of the run which was just queued #4001. This is because of the async nature of how Actions events are processed.

[samcoe]

Going to close this for now as it is blocked by #4001. If that gets resolved we can revisit this idea.

[nidnogg]

Is this completed? Still blocked? Would love to see this feature - some types of CI/CD runs I have get blocked on this.