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

CI is too noisy #4

Open
qlyoung opened this issue Nov 9, 2021 · 1 comment
Open

CI is too noisy #4

qlyoung opened this issue Nov 9, 2021 · 1 comment

Comments

@qlyoung
Copy link
Member

qlyoung commented Nov 9, 2021

NetDEF and LabN CI systems both post comments as bot users when a test suite passes or fails, for example:

image

Because a new comment is posted for each new test result, this can become very noisy, even when previous comments are collapsed. The comment section of a pull request is intended for human users to use for discussing the pull request. Posts from bots disrupt this use case.

GitHub hastwo complementary features, together called "Status checks", that are designed for this purpose. These are represented by compact status lines at the bottom of a pull request, in the status box:

image

Presently all CI systems post "Statuses". These statuses contain all necessary information for reviewers - whether the CI run passed or failed, and a link to further details.

In the case of a CI success, it is unnecessary to post a comment indicating that the CI passed. This is redundant information because the same information is present in the form of a green check mark at the bottom of a pull request.

In the case of a CI failure, all details about the failure can be placed directly in GitHub as a "check" result, for example here is a recent one posted by frrbot:
https://github.com/FRRouting/frr/pull/10006/checks?sha=b13f35ec6772ae3a2bcff78c9b4ff388278685b3

In this example, rather than posting a comment, the bot is able to post a Check result instead, which frees up the comment section for human users, improving the workflow.

Therefore I request that NetDEF CI transition to using check results in order to remove PR noise. This can be accomplished in two steps:

  • Stop posting comments on success

This is easy because no additional work needs to be done. All that needs to be done is to remove the code which posts a comment on CI success.

  • Move comment contents to a Status Check and stop posting comments on failure

This requires using the Checks API and requires some effort.

@qlyoung
Copy link
Member Author

qlyoung commented Nov 9, 2021

One problem is that some developers are now accustomed to CI emulating human users and rely on email notifications of comments from CI showing up in their email in order to know when to go look at a pull request. One possible workaround here is to post the comments and then delete them afterwards in order to generate an email while also not contributing to the noise of the pull request itself.

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

1 participant