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

CLA check should use github status checks API to display CLA check result details. #177

Closed
jtattermusch opened this issue Sep 4, 2019 · 6 comments

Comments

@jtattermusch
Copy link

a new CLA check has bot has recently been enabled for the gRPC project (https://github.com/grpc/grpc), but the way the check results are being presented is interfering with our test results and making them less readable.

what the new bot does is that it displays "EasyCLA" status on each PR (same as the previous bot) but also displays a separate check entry for each individual contributor (in the example "Steven E Wright" entry is added to the list of green tickmarks of that PR. This is probably done as an attempt to increase the amount of details provided by the bot, but it's not the right way to do this. In practice it means the names of contributors are thrown randomly into the list of test suites that run on each PR and they are making things look messy.
Ideally the bot would use the github status checks API (right now the "commit status API" is being used), there would be only one entry in the test result overview ("EasyCLA") and clicking on the "Details" link would display additional details about the individual contributors and their signing status (and links to the CLA details). This is exactly why status check API was introduced - to be able to display additional details around checks in a standard way.

grpc/grpc#20123

example of a github status check:
https://github.com/grpc/grpc/pull/20123/checks

@jtattermusch
Copy link
Author

CC @caniszczyk, @nicolasnoble

@dankohn
Copy link

dankohn commented Sep 4, 2019

Thanks for the detailed issue here. @jpalmerLinuxFoundation I believe this was already fixed, right, where EasyCLA now only posts into issues when it fails?

@jpalmerLinuxFoundation
Copy link
Contributor

jpalmerLinuxFoundation commented Sep 4, 2019 via email

@jtattermusch
Copy link
Author

I can confirm that when CLA check passes, there's only one "EasyCLA" status on our PRs. That said,
it probably still would make sense to turn the github commit status into a "status check" and provide more details in the "Checks" tab on the PR. Right now the "Details" link leads to "https://lfcla.com/" which is not really that helpful. If it instead showed a status check tab with additional details, it would be much more informative and useful.

@jpalmerLinuxFoundation
Copy link
Contributor

jpalmerLinuxFoundation commented Sep 5, 2019

Hi Jen, that's really good feedback. I've created a ticket to improve the information available. If you could add to the ticket to help improve it that would be valuable: #169

@dealako
Copy link
Member

dealako commented Nov 26, 2019

This issue seems resolved with additional scope/discussion noted on #169.

Closing this issue during our backlog review. If additional help (be specific) is needed then please create a new ticket.

@dealako dealako closed this as completed Nov 26, 2019
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

4 participants