Add guidance on Rake task usage in checks

Brie Carranzarequested to merge
bcarranza-add-notes-on-rake-usage-for-checks into main

During a recent demo, a customer inquired about Rake tasks in GitLab Detective. In this MR, I am hoping to record our stance on using Rake tasks in GitLab Detective. The notes in the initial draft of the MR are based on a sync conversation on 2025-07-04.

A few additional notes to be aware of:

  • 🚀 Speed is a focus for GitLab Detective.
    • That's one reason why we said "no" by default to checks that require gitlab-rails console.
    • That's one reason why we are refraining from using gitlab-rake in checks.
  • 📡 Scope is important to get right.
    • GitLab Detective checks are meant to be very precise. Each check should be focused on one specific "problem". See additional notes on scope here.
    • The Rake tasks tend to focus on many things and don't think about "what to do about it" in the same way.
    • Elsewhere, we have discussed the importance of helping customers to understand the relationship between different diagnostic tools made available by GitLab and when to use each one.
Edited by Brie Carranza

Merge request reports