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

Reduce comment noise: produce only a single comment per artifact #134

Open
rtyley opened this issue May 16, 2024 · 3 comments
Open

Reduce comment noise: produce only a single comment per artifact #134

rtyley opened this issue May 16, 2024 · 3 comments

Comments

@rtyley
Copy link
Member

rtyley commented May 16, 2024

At the moment, actions-riff-raff automatically produces one PR comment per riff-raff artifact - this gets noisy on projects with many artifacts - eg Ophan, with 8 comments, or editorial-tools-platform, with 12 comments.

We don't want developers to have to hunt for non-bot comments on PRs - the human-written comments on PRs are generally the most important ones, and shouldn't be lost in a swarm of bot comments! Consequently, we should restrict the automatic commenting by actions-riff-raff to one comment per PR - with that comment updated as new artifacts (and ideally commits) arrive.

See also some previous comments about this issue:

@akash1810
Copy link
Member

akash1810 commented Jul 1, 2024

I think producing one comment is likely the best behaviour, however it's worth mentioning an alternative that exists today would be to split across GitHub workflow files. The guardian/deploy-tools-platform repository does this, for example. The trade-off is increased complexity to the workflow files, with the setting of paths within the on directive.

@akash1810
Copy link
Member

Another example of noisy comments - guardian/support-service-lambdas#2587.

@akash1810
Copy link
Member

#184 is a pragmatic attempt to improve the DX here. Its only pragmatic; the ideal would be to produce exactly one comment with all the links.

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

2 participants