linear-b / gitstream

/:\ gitStream - Workflow automation for your git repo. Use YAML to auto-assign reviewers, auto-merge PRs, automatic PR labeler, and more.
https://gitstream.cm
Apache License 2.0
254 stars 30 forks source link

IntelliJ GitHub Pull Request Integration looks awful with code experts check #481

Open tresat opened 4 months ago

tresat commented 4 months ago

Describe the bug

The newest version of IntelliJ has support for opening GitHub PRs in the IDE, see: https://blog.jetbrains.com/idea/2024/02/intellij-idea-2024-1-eap-6/#in-editor-code-review and https://www.jetbrains.com/help/idea/work-with-github-pull-requests.html#provide-feedback.

This also shows the PR's comments directly in the editor. This feature does not play nicely with the code experts check.

To Reproduce

Steps to reproduce the behavior:

  1. Open a PR in IntelliJ that has gitStream enabled and has received a code experts comment.
  2. An example PR: https://github.com/gradle/gradle/pull/28653
  3. In the IDE, the code experts comment is rendered as a gigantic several-"page" document that gets in the way of other more relevant human comments on the PR, to the point the people unfamiliar with the system might not even realize those other comments are visible here.

Expected behavior

This comment should be condensed somehow. Even better, it could be rendered as a collapsable HTML table in the IDE.

Screenshots image image image

Additional context

Very likely this is nothing specific to gitStream. It will probably have to be addressed on the IntelliJ side. However, the way the month abbreviations ("APR", "MAR") are split across multiple lines makes me wonder if something could be done in gitStream (perhaps with more HTML?) to make the table at least look usable within the IDE.

BenLloydPearson commented 4 months ago

Thanks for reporting this @tresat. Have you noticed this problem with any of the other automations you use that post comments? In particular, I'd be interested to see if the summary table automation you have renders properly.