feature: add --watch option to gh workflow run - #6965

I'm concerned about how brittle this is; it's easy to imagine ending up watching the wrong run on a repository with frequent runs.

No debate on that here!

Is there a way to make this more reliable by filtering runs by workflow file and ref?

That seems like it should be possible, although (being as new as this PR to the code overall) I'm not certain. I'll take a look and report back.

Hey @mik3y, since @vilmibm is no longer at GitHub, I've assigned this to myself to review. The last message was you planning to make some changes and coming back to us. Are you planning to continue working on this and if so is there something we can do to help you move this forward?

@williammartin thanks for the nudge! I think this is ready for another look.

In addition to rebasing, I've applied vilmibm's prior suggestion to use an additional filter (the workflow id) when searching for the "new" run ID. It's been working well.

It would still be preferable to close #4001 and resolve this without needing a heuristic, but such an improvement could could of course be made later, under-the-hood of the new --watch interface.

It will fail if there are multiple runs created for same workflow. You might end up watching for other run

@williammartin thanks for the nudge! I think this is ready for another look.

In addition to rebasing, I've applied vilmibm's prior suggestion to use an additional filter (the workflow id) when searching for the "new" run ID. It's been working well.

It would still be preferable to close #4001 and resolve this without needing a heuristic, but such an improvement could could of course be made later, under-the-hood of the new --watch interface.

@mik3y: Yeah, having the GitHub REST API endpoints for creating workflow runs return an ID on call is a question / comment / suggestion I've seen within our internal subject matter experts GitHub Actions channel for some time. I've followed up internally to add the GitHub CLI to the list of customers and other users who have requested this.

All that said, I'll defer to @williammartin as having been working with you on the issue on your updates and the concern raised about selecting the right workflow run.

@mik3y : I'm going to close this PR rather than keeping this it open indefinitely while I continue to advocate for the GitHub Actions team to enhance Create a workflow dispatch event REST endpoint. There appears to be added complexity with correlating workflow runs depending on whether you use .run-name feature of a workflow that I think we want to wait for the dispatch endpoint to return the ID in order to implement this feature.

Once again, thank you for your time and patience! ❤️ 🙇

@andyfeller understood, thanks for pushing on the blocker issue.

For anyone coming to this issue/PR in the meantime, fwiw, I've been running a build of this fork as my ~/bin/gh & enjoying gh workflow run --watch for over a year with success; so it might tide you over until #4001 is resolved.