github-api icon indicating copy to clipboard operation
github-api copied to clipboard

Enhancement: support name update for GitHub Check Run

Open igorsmotto opened this issue 3 years ago • 2 comments

Currently, both create and update of a GitHub Check Run are handled by GHCheckRunBuilder class. For the update, this is done by constructing an instance with the checkId

Following the latest GitHub documentation about the GitHub Check Run Update API it's possible to update the name of the Check Run through it, however, GHCheckRunBuilder doesn't expose a method for it.

This is probably because the builder is currently handling both create (which doesn't allow it) and update.

However, not sure what's the best approach to enable this, the easiest option that I could think of is by creating a new method withName to the Builder that throws an exception (a simple GHException) if the instance was created with a name - which means it's not an update.

igorsmotto avatar Dec 28 '22 02:12 igorsmotto

Sure, that sounds reasonable.

bitwiseman avatar Dec 28 '22 23:12 bitwiseman

I would like to work on this issue. Is there anything else that I should know about this issue.

halkey avatar Dec 04 '23 11:12 halkey