Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch From GitHub Commit Statuses API to Checks API #340

Open
midnightconman opened this issue Dec 6, 2024 · 6 comments
Open

Switch From GitHub Commit Statuses API to Checks API #340

midnightconman opened this issue Dec 6, 2024 · 6 comments

Comments

@midnightconman
Copy link
Contributor

Prow uses github commit statuses to interact with PRs (all the components that interact with these I don't know yet), should we switch from commit statuses to the new checks api? Checks seem much more featureful than commit statuses. Thoughts, comments, concerns?

@Prucek
Copy link
Member

Prucek commented Dec 6, 2024

+1
I talked about this with @petr-muller, and he would agree that Prow deserves some modernization.

@petr-muller
Copy link
Contributor

I'm favor of this generally. Two roadbumps I recall from earlier discussions, they may not describe the current situation well though:

  • Checks API had some issues with PAT authentications, IIRC parts of it were only available to GH Apps? I hope most Prow installations use GH Apps now but it is possible that we'd need to deprecate PATs
  • IIRC check results were quite tricky to read / process from e.g. the Tide PoV, the check names / IDs were weird somehow. I remember this was causing issues when we tried to interface with GH actions better, but it's a while now

@midnightconman
Copy link
Contributor Author

Checks API had some issues with PAT authentications, IIRC parts of it were only available to GH Apps?

There is conflicting information in the github documents about this, where it says you need to use a github app to use various checks apis, but then it says it supports "Fine-grained personal access tokens": https://docs.github.com/en/rest/checks/runs?apiVersion=2022-11-28#create-a-check-run

@petr-muller
Copy link
Contributor

Fine-grained personal access tokens are quite new actually, introduced in late 2022, which means they are newer than apps. My memory is definitely from before that. So it is quite likely that only the "old" PATs are not able to interact with checks.

@midnightconman
Copy link
Contributor Author

So maybe we should think about deprecating "classic" personal access tokens usage?

@petr-muller
Copy link
Contributor

Yeah, I would not be against that, but we'd need a reasonable transition period.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants