Improve GitHub In-PR experience

What do we think about building an in-PR reporter? That’d probably be in the form of a single comment in the PR summarizing the current status of DeepSource’s analyzer (# of issues introduced / resolved) + a direct link to the PR overview. The going through the issues experience should probably still live in DeepSource for now.

My main issue with the current way of just using the GitHub status is that in order to get to DeepSource I have to click twice: the first time on “Details” in the PR screen, and then again in the “View more details on deepsource.io” link. It’s a small thing, but it adds a couple seconds to my workflow which is annoying when building many times.

1 Like

@fanahova Sure. We post a short summary in the pull request with the summary of the changes at the moment. Do let us know what more information in this summary would make it better.


Regarding, multiple clicks in the PR workflow: Totally agree. Many users have given this feedback. Clicking twice gets annoying when done repeatedly. GitHub recommends using the Checks API which doesn’t allow us to add deepsource.io link to the ‘Details’ button. There is an old status API which allows this behaviour but GitHub recommends new checks API as it has more features like check retries / detailes report etc. Will explore more on this and see what we can do to improve this behaviour. Let’s keep the topic open.

1 Like

The info is all there, as you mentioned I just don’t like the fact that it’s in a different page from the PR main overview. Can we build a Danger-like experience where a bot posts a comment in the PR with a link to the page, on top of the status API? We should have the right permissions for it through the app already right?

2 Likes

In the initial version, we had an integration with GitHub via Review comments API and post the issues directly as inline comments to the GitHub diff view.

But this led to bad experience in the diff view when reviewing code as there is no direct way to toggle DeepSource’s comments in the view. Sometimes the issue needed pretty long description to explain what the issue is. Also, this API is very limited to show all the details of the issue (for ex: issue category, ignoring rules, reporting false positives, etc.) – which is why we want to keep these things within DeepSource so we have more flexibility.

We’re actively exploring the status API which provides single click workflow to the DeepSource issues page.

I agree that it should stay on DeepSource and not in-line; I was thinking more of something like Danger:

With the exact same info from the screenshot you sent before, but as a in-PR comment with a direct link, rather than needing me to click “Details” to see. Same experience, but one less click to get to DeepSource. Happy to mock it up for you if I didn’t explain it the right way, sorry about the confusion!

1 Like

Ah. Understood. That’s neat. Now I get what you were saying in the previous comment – we already have permission to post comments in the PR. Will discuss internally and keep you posted. Thanks for the feedback :slight_smile: