Add new version field to GitHub API requests

[robdimsdale]

In a recent blog post GitHub announced a new API versioning scheme.

TL;DR - we should add: X-GitHub-Api-Version: 2022-11-28 to all REST API calls. In the future when new versions of the API are released, we can evaluate if we want to bump to that new version.

[robdimsdale]

It looks like recent versions of the gh cli will automatically add this HTTP header for us. Presumably the CLI will also know which version of an API to use for a given command once GitHub supports multiple versions of the API.

Therefore I think we should strongly consider using the gh CLI (instead of e.g. curl) everywhere we make GitHub API requests.

Example CLI request:

❯ DEBUG=api gh auth status
[ ... request headers ... ]

< HTTP/2.0 200 OK
[ ... response headers ... ]
< X-Github-Api-Version-Selected: 2022-11-28
[ ... ]

[robdimsdale]

As a first step, I think there is no reason we should not use gh instead of curl inside of actions. It is easier to use and is generally available in all images that actions run on.

We can push out the conversation of using gh in scripts that run on local workstations as well as in CI, as that would require users to install gh which would be a breaking change in the UX.