prontolabs / pronto

Quick automated code review of your changes
MIT License
2.62k stars 245 forks source link

improve documentation for integrating with GitLab CI #462

Closed webit-richardkramer closed 5 months ago

webit-richardkramer commented 5 months ago

When implementing pronto in our GitLab CI we ran into an issue when having more than 50 commits in an MR. In this case, pronto simply showed all issues, not only the ones in our changes.

The cause of this was GitLabs git depth (50 by default for us, 20 on newer installations). Unfortunately, it is not enough to separately fetch the target branch (which was already present in the docs), but also to refetch the history of HEAD beyond the initial fetch depth. You could also do this explicitely, by I found it cleaner to simply disable the git depth for this one job.

In case others stumble upon the same problem, I want to update the docs a bit to reflect this need of disabling git depth.

ashkulz commented 5 months ago

Thanks for the contribution, @webit-richardkramer!